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          */
  90         public function isRequestElementSet ($element) {
  91                 // Is this element found?
  92                 if (!isset($this->requestData[$element])) {
  93                         // Then return false
  94                         return false;
  95                 } // END - if
  96
  97                 // All clear
  98                 return true;
  99         }
 100
 101         /**
 102          * Getter for request element or 'null' if the element was not found
 103          *
 104          * @param       $element        Name of the request element we want to check
 105          * @return      $value          Value of the found request element or 'null' if the
 106          *                                              element was not found
 107          */
 108         public function getRequestElement ($element) {
 109                 // Initialize value
 110                 $value = null;
 111
 112                 if ($this->isRequestElementSet($element)) {
 113                                 $value = $this->requestData[$element];
 114                 } // END - if
 115
 116                 // Return the element's value
 117                 return $value;
 118         }
 119
 120         /**
 121          * Setter for request elements
 122          *
 123          * @param       $element        Request element to se
 124          * @param       $value          Value to set
 125          * @return      void
 126          */
 127         public function setRequestElement ($element, $value) {
 128                 $this->requestData[$element] = $value;
 129         }
 130
 131         /**
 132          * Wrapper method for array_key() function for the request data array
 133          *
 134          * @return      $array  An array containing all array keys to return
 135          */
 136         public function getParameterNames () {
 137                 return array_keys($this->requestData);
 138         }
 139
 140         /**
 141          * Getter for a header element or 'null' if the header was not found
 142          *
 143          * @param       $headerName             Name of the header
 144          * @return      $headerValue    Value of the header or 'null' if not found
 145          */
 146         public function getHeader ($headerName) {
 147                 // Default return value on error
 148                 $headerValue = null;
 149
 150                 // Construct the name
 151                 $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));
 152
 153                 // Does this header exist?
 154                 if (isset($_SERVER[$name])) {
 155                         $headerValue = $_SERVER[$name];
 156                 } // END - if
 157
 158                 // Return the value
 159                 return $headerValue;
 160         }
 161
 162         /**
 163          * Getter for request method. This getter might be useful for security filters
 164          *
 165          * @return      $requestMethod  Used request method
 166          */
 167         public final function getRequestMethod () {
 168                 return $_SERVER['REQUEST_METHOD'];
 169         }
 170
 171         /**
 172          * Sets wether the request was valid (default: true)
 173          *
 174          * @param       $isValid        Wether the request is valid
 175          * @return      void
 176          */
 177         public final function requestIsValid ($isValid = true) {
 178                 $this->requestIsValid = (bool) $isValid;
 179         }
 180
 181         /**
 182          * Returns wether this request is valid
 183          *
 184          * @return      $requestIsValid         Wether this request is valid
 185          */
 186         public final function isRequestValid () {
 187                 return $this->requestIsValid;
 188         }
 189
 190         /**
 191          * Reads a cookie and returns it's value or null if not found
 192          *
 193          * @param       $cookieName             Name of cookie we shall read
 194          * @return      $cookieValue    Value of cookie or null if not found
 195          */
 196         public final function readCookie ($cookieName) {
 197                 // Default is no cookie with that name found
 198                 $cookieValue = null;
 199
 200                 // Is the cookie set?
 201                 if (isset($_COOKIE[$cookieName])) {
 202                         // Then get it
 203                         $cookieValue = $_COOKIE[$cookieName];
 204                 } // END - if
 205
 206                 // Return the value
 207                 return $cookieValue;
 208         }
 209 }
 210
 211 // [EOF]
 212 ?>