Source for file Input.class.php

Documentation is available at Input.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 User Input 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 User Input Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. interface Gumbo_Interface_Http_Input {
  34.  
  35.     /** ACTION METHODS **/
  36.     /**
  37.      * Adds a Constraint to a given field
  38.      * @param string $field 
  39.      * @param Gumbo_Interface_Constraint $obj 
  40.      * @param bool $return_val if Constraint returns a value
  41.      */
  42.     public function addConstraint ($field, Gumbo_Interface_Constraint $obj, $return_val=false);
  43.     
  44.     /**
  45.      * Resets Constraints
  46.      * @param string $field 
  47.      * @throws Gumbo_Exception
  48.      */
  49.     public function resetInput ($field);
  50.     
  51.     
  52.     
  53.     /** MUTATOR METHODS **/
  54.     /**
  55.      * Sets if the object should ignore the status code and return raw data
  56.      * @param bool $val 
  57.      */
  58.     public function setIgnoreConstraints ($val);
  59.     
  60.     
  61.     
  62.     /** ACCESSOR METHODS **/
  63.     /**
  64.      * Returns the Constaints of the supplied field
  65.      * @param string $field 
  66.      * @return Gumbo_Interface_Input 
  67.      */
  68.     public function getInput ($field);
  69.     
  70.     /**
  71.      * Returns if the field has a constraint
  72.      * @param string $field 
  73.      * @return bool 
  74.      */
  75.     public function hasInput ($field);
  76.     
  77.     /**
  78.      * Returns if data should be returned raw
  79.      * @return bool 
  80.      */
  81.     public function toIgnoreConstraints ();
  82.     
  83. }
  84.  
  85. ?>