inc/classes/main/request/class_HttpRequest.php

   1 <?php
   2 /**
   3  * A concrete HTTP request class to make HTTP requests more abstract
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   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 class HttpRequest extends BaseFrameworkSystem implements Requestable {
  25         /**
  26          * Array for the request data
  27          */
  28         private $requestData = array();
  29
  30         /**
  31          * Wether this request is valid and can be further processed. The default is
  32          * valid so make sure your intercepting filters sets this attribute to false
  33          * when they need to intercept the data flow.
  34          */
  35         private $requestIsValid = true;
  36
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45
  46                 // Set part description
  47                 $this->setObjectDescription("HTTP request");
  48
  49                 // Create unique ID number
  50                 $this->generateUniqueId();
  51
  52                 // Clean up a little
  53                 $this->removeNumberFormaters();
  54                 $this->removeSystemArray();
  55         }
  56
  57         /**
  58          * Creates an instance of this class and prepares it a little
  59          *
  60          * @return      $httpInstance   An instance of this class
  61          */
  62         public final static function createHttpRequest () {
  63                 // Create an instance
  64                 $httpInstance = new HttpRequest();
  65
  66                 // Prepare the HTTP request data for usage
  67                 $httpInstance->prepareRequestData();
  68
  69                 // Return the prepared instance
  70                 return $httpInstance;
  71         }
  72
  73         /**
  74          * Prepares the HTTP request data for usage by currently copying
  75          * $_REQUEST into a private attribute. Later on we can add more
  76          * things for initialization here.
  77          *
  78          * @return      void
  79          */
  80         public function prepareRequestData () {
  81                 // Copy the $_REQUEST array
  82                 $this->requestData = $_REQUEST;
  83         }
  84
  85         /**
  86          * Checks wether a request element is set
  87          * @param       $element        Name of the request element we want to check
  88          * @return      $isSet          Wether the request element is set
  89          * @throws      MissingArrayElementsException   Thrown if a request element is not set
  90          */
  91         public function isRequestElementSet ($element) {
  92                 // Is this element found?
  93                 if (!isset($this->requestData[$element])) {
  94                         // Then throw an exception
  95                         throw new MissingArrayElementsException(array($this, 'requestData', $element), self::EXCEPTION_MISSING_ELEMENT);
  96                 } // END - if
  97
  98                 // All clear
  99                 return true;
 100         }
 101
 102         /**
 103          * Getter for request element or 'null' if the element was not found
 104          *
 105          * @param       $element        Name of the request element we want to check
 106          * @return      $value          Value of the found request element or 'null' if the
 107          *                                              element was not found
 108          */
 109         public function getRequestElement ($element) {
 110                 // Initialize value
 111                 $value = null;
 112
 113                 try {
 114                         if ($this->isRequestElementSet($element)) {
 115                                 $value = $this->requestData[$element];
 116                         } // END - if
 117                 } catch (MissingArrayElementsException $e) {
 118                         // Do nothing here
 119                 }
 120
 121                 // Return the element's value
 122                 return $value;
 123         }
 124
 125         /**
 126          * Setter for request elements
 127          *
 128          * @param       $element        Request element to se
 129          * @param       $value          Value to set
 130          * @return      void
 131          */
 132         public function setRequestElement ($element, $value) {
 133                 $this->requestData[$element] = $value;
 134         }
 135
 136         /**
 137          * Wrapper method for array_key() function for the request data array
 138          *
 139          * @return      $array  An array containing all array keys to return
 140          */
 141         public function getParameterNames () {
 142                 return array_keys($this->requestData);
 143         }
 144
 145         /**
 146          * Getter for a header element or 'null' if the header was not found
 147          *
 148          * @param       $headerName             Name of the header
 149          * @return      $headerValue    Value of the header or 'null' if not found
 150          */
 151         public function getHeader ($headerName) {
 152                 // Default return value on error
 153                 $headerValue = null;
 154
 155                 // Construct the name
 156                 $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));
 157
 158                 // Does this header exist?
 159                 if (isset($_SERVER[$name])) {
 160                         $headerValue = $_SERVER[$name];
 161                 } // END - if
 162
 163                 // Return the value
 164                 return $headerValue;
 165         }
 166
 167         /**
 168          * Getter for request method. This getter might be useful for security filters
 169          *
 170          * @return      $requestMethod  Used request method
 171          */
 172         public final function getRequestMethod () {
 173                 return $_SERVER['REQUEST_METHOD'];
 174         }
 175
 176         /**
 177          * Sets wether the request was valid (default: true)
 178          *
 179          * @param       $isValid        Wether the request is valid
 180          * @return      void
 181          */
 182         public final function requestIsValid ($isValid = true) {
 183                 $this->requestIsValid = (bool) $isValid;
 184         }
 185
 186         /**
 187          * Returns wether this request is valid
 188          *
 189          * @return      $requestIsValid         Wether this request is valid
 190          */
 191         public final function isRequestValid () {
 192                 return $this->requestIsValid;
 193         }
 194
 195         /**
 196          * Reads a cookie and returns it's value or null if not found
 197          *
 198          * @param       $cookieName             Name of cookie we shall read
 199          * @return      $cookieValue    Value of cookie or null if not found
 200          */
 201         public final function readCookie ($cookieName) {
 202                 // Default is no cookie with that name found
 203                 $cookieValue = null;
 204
 205                 // Is the cookie set?
 206                 if (isset($_COOKIE[$cookieName])) {
 207                         // Then get it
 208                         $cookieValue = $_COOKIE[$cookieName];
 209                 } // END - if
 210
 211                 // Return the value
 212                 return $cookieValue;
 213         }
 214 }
 215
 216 // [EOF]
 217 ?>