Login   Register  
PHP Classes
elePHPant
Icontem

File: Xyndravandria/Averazain/PageCollection.php

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Mauro Di Girolamo  >  Xyndravandria Averazain  >  Xyndravandria/Averazain/PageCollection.php  >  Download  
File: Xyndravandria/Averazain/PageCollection.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Xyndravandria Averazain
Handle AJAX requests with PHP classes
Author: By
Last change: Alpha 0.0.0
Date: 1 year ago
Size: 5,298 bytes
 

Contents

Class file image Download
<?php
/*
=============================================================================================================================================
|   This file is part of a project released under the terms of the Xyndravandria PHP License (XyndravandriaPHPLicense.txt).                 |
|                                                                                                                                           |
|   You should be given a copy of the Xyndravandria PHP License (XyndravandriaPHPLicense.txt) within the same directory as the README.md;   |
|   if not, you can get a copy at http://Xyndravandria.ohost.de/XyndravandriaPHPLicense.txt .                                               |
|                                                                                                                                           |
|   The copyright (c) of this project is owned by Mauro Di Girolamo <maurodigirolamo@.web.de>.                                              |
============================================================================================================================================|



Xyndravandria Averazain
-----------------------
Alpha 0.0.0

Xyndravandria is the name of a collection of projects designed and developed by Mauro Di Girolamo (maurodigirolamo@web.de); he is therefore the copyright (c) owner of Xyndravandria itself and all of its projects.

Xyndravandria Averazain is released under the terms of the Xyndravandria PHP License (XyndravandriaPHPLicense.txt). You should be given a copy of the Xyndravandria PHP License (XyndravandriaPHPLicense.txt) within the same directory as the README.md; if not, you can get a copy at http://Xyndravandria.ohost.de/XyndravandriaPHPLicense.txt . There might be a release under a freer license for a later, more stable version.

The documentation is either included in ./admin_media/Documentation/ or can be read at http://Xyndravandria.ohost.de/Averazain/Documentation/.

All projects:

   Xyndravandria Averazain
   http://github.com/MauroDiGirolamo/Xyndravandria_Averazain
   PHP
   Averazain is an Ajax framework supporting also JavaScript disabled clients perfectly - including search engines like Google.
   
   Xyndravandria Dyverath
   http://github.com/MauroDiGirolamo/Xyndravandria_Dyverath
   PHP
   Dyverath is a database access wrapper.
   
   Xyndravandria Erozaver
   http://github.com/MauroDiGirolamo/Xyndravandria_Erozaver
   PHP
   Erozaver is a class extending the type hinting given by the PHP engine (additional support for basic type hinting and size constraints).
   
   Xyndravandria Mondraviel
   http://github.com/MauroDiGirolamo/Xyndravandria_Mondraviel
   PHP
   Mondraviel is a class used to separate HTML from PHP code by firstly register models - files containing place holders embedded in HTML code - and then later fill them dynamically with content by passing values for the place holders.
*/

namespace Xyndravandria\Averazain;

/// Any class to be registered to Averazain must
/// implement this interface. @n
/// It requires three methods: Anchor( ), Authorise( )
/// and Target( ).
interface PageCollection {
   
   
/// Averazain will call this method to determine the
   /// anchor of a certain method. @n
   /// Returning null means that a method has no anchor.
   /// @n
   /// An anchor can be seen as an alias of a certain
   /// method used either as an argument of a GET
   /// request or a JavaScript hash in order to request
   /// an invoking of that certain method. @n
   /// GET request: Index.php?Anchor:Argument1,Argument2
   /// @n Javascript hash: Index.php\#Anchor:Argument1,Argument2 @n
   /// As you can see, there is also the possibility of
   /// passing arguments to the method. @n
   /// If a script is executed with such an anchor,
   /// Averazain will call the associated method. @n
   /// That said, anchors might be used to create
   /// hyperlinks to certain sections of your website.
   /// @public
   /// @static
   /// @param $Method: Method name to get the anchor of.
   /// @returns string or null
   
public static function Anchor$Method );

   
/// This method is called whenever Averazain receives
   /// an Ajax request from the client demanding to call
   /// a method of a PageCollection. @n
   /// Returns true if a client is authorised to call the
   /// requested method, else false.
   /// @public
   /// @static
   /// @param $Method: The requested method.
   /// @returns boolean
   
public static function Authorise$Method );

   
/// Averazain calls this method to get the target of a
   /// method which has been called by demand of an Ajax
   /// request. The target is sent to the server within
   /// an Ajax request and later used when Averazain
   /// receives the Ajax response. @n
   /// Unless you overwrite the JavaScript method
   /// XyndravandriaAverazain.OnRequestStateChange( XHR,
   /// Target, Argument ) - you are welcomed to do so -,
   /// the target is a string containing an element's id
   /// whose inner HTML will be changed. @n
   /// Returning null means that a method has no target.
   /// @public       
   /// @static      
   /// @param $Method: Method name to get the target of.
   /// @returns string or null
   
public static function Target$Method );
   
}
?>