inc/classes/interfaces/request/class_Requestable.php

   1 <?php
   2 /**
   3  * An interface for requests
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface Requestable extends FrameworkInterface {
  25         /**
  26          * Prepares the request data for usage
  27          *
  28          * @return      void
  29          */
  30         function prepareRequestData ();
  31
  32         /**
  33          * Checks whether a request element is set
  34          *
  35          * @param       $element        Name of the request element we want to check
  36          * @return      $isSet          Whether the request element is set
  37          * @throws      MissingArrayElementsException   Thrown if a request element is not set
  38          */
  39         function isRequestElementSet ($element);
  40
  41         /**
  42          * Getter for request element or 'null' if element was not found
  43          *
  44          * @param       $element        Name of the request element we want to check
  45          * @return      $value          Value of the found request element or 'null' if the
  46          *                                              element was not found
  47          */
  48         function getRequestElement ($element);
  49
  50         /**
  51          * Wrapper method for array_key() function for the request data array
  52          *
  53          * @return      $array  An array containing all array keys to return
  54          */
  55         function getParameterNames ();
  56
  57         /**
  58          * Getter for a header element or 'null' if header was not found
  59          *
  60          * @param       $headerName             Name of the header
  61          * @return      $headerValue    Value of the header or 'null' if not found
  62          */
  63         function getHeader ($headerName);
  64
  65         /**
  66          * Sets whether the request was valid (default: true)
  67          *
  68          * @param       $isValid        Whether the request is valid
  69          * @return      void
  70          */
  71         function requestIsValid ($isValid = true);
  72
  73         /**
  74          * Reads a cookie and returns it's value or null if not found
  75          *
  76          * @param       $cookieName             Name of cookie we shall read
  77          * @return      $cookieValue    Value of cookie or null if not found
  78          */
  79         function readCookie ($cookieName);
  80 }
  81
  82 // [EOF]
  83 ?>