Source for file Request.class.php

Documentation is available at Request.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 Http
  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.  * HTTP Request Interface
  22.  *
  23.  * @category Gumbo
  24.  * @package Http
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc HTTP Request Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. interface Gumbo_Interface_Http_Request {
  34.     
  35.     /** OVERLOAD METHODS **/
  36.     /**
  37.      * Returns the value of the $_REQUEST field based on the mode
  38.      * @param string $fld 
  39.      * @return mixed 
  40.      */
  41.     public function __get ($fld);
  42.     
  43.     /**
  44.      * Returns if the field exists in the REQUEST array
  45.      * @param string $fld 
  46.      * @return mixed 
  47.      */
  48.     public function __isset ($fld);
  49.     
  50.     
  51.     
  52.     /** ACTION METHODS **/
  53.     /**
  54.      * Validates the $_REQUEST variable Input Constraints (if null, validates all)
  55.      * @param string $field 
  56.      */
  57.     public function validate ($field=null);
  58.     
  59.     
  60.     
  61.     /** MUTATOR METHODS **/
  62.     /**
  63.      * Sets the default return mode (request|cookie|post|get)
  64.      * @param string $mode 
  65.      */
  66.     public function setMode ($mode);
  67.     
  68.     
  69.     
  70.     /** ACCESSOR METHODS **/
  71.     /**
  72.      * Returns the value of the $_REQUEST field
  73.      * @param string $field 
  74.      * @param string $mode 
  75.      * @return mixed 
  76.      */
  77.     public function get ($field, $mode=null);
  78.     
  79.     /**
  80.      * Returns an array map of User Input
  81.      * @param bool $reload reloads the map
  82.      * @return array 
  83.      */
  84.     public function getMap ($reload=false);
  85.     
  86.     /**
  87.      * Returns the HTTP request method
  88.      * @return string 
  89.      */
  90.     public function getMethod ();
  91.     
  92.     /**
  93.      * Returns the mode return values will be retrieved from
  94.      * @return string 
  95.      */
  96.     public function getMode ();
  97.     
  98. }
  99.  
  100. ?>