Source for file Router.class.php

Documentation is available at Router.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Router
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Router Interface
  22.  * 
  23.  * A Router is simply a class that changes the current location of the browser
  24.  * to the specified URL.  In order to jump, the object must be active.  The Delay
  25.  * is meant to hold from the jump for a given amount of time (in seconds).  The
  26.  * Flush option will flush the buffer before routing.
  27.  *
  28.  * @category Gumbo
  29.  * @package Router
  30.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  31.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  32.  * @author Michael Luster <mluster79@yahoo.com>
  33.  * @link http://sourceforge.net/projects/phpgumbo
  34.  * @desc Router Interface
  35.  * @version 0.0.1
  36.  */
  37.  
  38. interface Gumbo_Interface_Router {
  39.     
  40.     /** ACTION METHODS **/
  41.     /**
  42.      * Jumps to the supplied URL
  43.      * @precondition isActive ()
  44.      */
  45.     public function go ();
  46.     
  47.     /**
  48.      * Activates the Router
  49.      * @postcondition isActive()
  50.      */
  51.     public function activate ();
  52.     
  53.     /**
  54.      * Deactivates the Router
  55.      * @postcondition !isActive()
  56.      */
  57.     public function deactivate ();
  58.     
  59.     
  60.     
  61.     /** MUTATOR METHODS **/
  62.     /**
  63.      * Sets the URL to jump to
  64.      * @precondition Valid_Web::isUrl ()
  65.      * @param string $url 
  66.      */
  67.     public function setUrl ($url);
  68.     
  69.     /**
  70.      * Sets the delay time, in seconds, before routing
  71.      * @precondition 0 <= delay <= 30
  72.      * @param int $delay 
  73.      */
  74.     public function setDelay ($delay);
  75.     
  76.     /**
  77.      * Sets the program to flush the buffer before routing
  78.      * @param bool $val 
  79.      */
  80.     public function setFlush ($val);
  81.     
  82.     
  83.     
  84.     /** ACCESSOR METHODS **/
  85.     /**
  86.      * Returns the Url
  87.      * @return string 
  88.      */
  89.     public function getUrl ();
  90.     
  91.     /**
  92.      * Returns the delay time, in seconds
  93.      * @return int 
  94.      */
  95.     public function getDelay ();
  96.     
  97.     /**
  98.      * Returns if the buffer should be flushed
  99.      * @return bool 
  100.      */
  101.     public function getFlush ();
  102.     
  103.     /**
  104.      * Returns if the Router is active
  105.      * @return bool 
  106.      */
  107.     public function isActive ();
  108.     
  109. }
  110.  
  111. ?>