inc/classes/main/request/class_HttpRequest.php

   1 <?php
   2 /**
   3  * A concrete and secured 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                 // Clean up a little
  47                 $this->removeNumberFormaters();
  48                 $this->removeSystemArray();
  49         }
  50
  51         /**
  52          * Creates an instance of this class and prepares it a little
  53          *
  54          * @return      $httpInstance   An instance of this class
  55          */
  56         public final static function createHttpRequest () {
  57                 // Create an instance
  58                 $httpInstance = new HttpRequest();
  59
  60                 // Prepare the HTTP request data for usage
  61                 $httpInstance->prepareRequestData();
  62
  63                 // Return the prepared instance
  64                 return $httpInstance;
  65         }
  66
  67         /**
  68          * Prepares the HTTP request data for usage by currently copying
  69          * $_REQUEST into a private attribute. Later on we can add more
  70          * things for initialization here.
  71          *
  72          * @return      void
  73          */
  74         public function prepareRequestData () {
  75                 // Copy GET then POST data
  76                 $this->requestData = array_merge($_GET, $_POST);
  77         }
  78
  79         /**
  80          * Checks wether a request element is set
  81          * @param       $element        Name of the request element we want to check
  82          * @return      $isSet          Wether the request element is set
  83          */
  84         public function isRequestElementSet ($element) {
  85                 // Is this element found?
  86                 if (!isset($this->requestData[$element])) {
  87                         // Then return false
  88                         return false;
  89                 } // END - if
  90
  91                 // All clear
  92                 return true;
  93         }
  94
  95         /**
  96          * Getter for request element or 'null' if the element was not found
  97          *
  98          * @param       $element        Name of the request element we want to check
  99          * @return      $value          Value of the found request element or 'null' if the
 100          *                                              element was not found
 101          */
 102         public function getRequestElement ($element) {
 103                 // Initialize value
 104                 $value = null;
 105
 106                 // Is the element set?
 107                 if ($this->isRequestElementSet($element)) {
 108                         // Get the bare value
 109                         $value = $this->requestData[$element];
 110
 111                         // Secure it against attacks
 112                         $value = htmlentities(strip_tags($value), ENT_QUOTES);
 113                 } // END - if
 114
 115                 // Return the element's value
 116                 return $value;
 117         }
 118
 119         /**
 120          * Setter for request elements
 121          *
 122          * @param       $element        Request element to se
 123          * @param       $value          Value to set
 124          * @return      void
 125          */
 126         public function setRequestElement ($element, $value) {
 127                 $this->requestData[$element] = $value;
 128         }
 129
 130         /**
 131          * Wrapper method for array_key() function for the request data array
 132          *
 133          * @return      $array  An array containing all array keys to return
 134          */
 135         public function getParameterNames () {
 136                 return array_keys($this->requestData);
 137         }
 138
 139         /**
 140          * Getter for a header element or 'null' if the header was not found
 141          *
 142          * @param       $headerName             Name of the header
 143          * @return      $headerValue    Value of the header or 'null' if not found
 144          */
 145         public function getHeader ($headerName) {
 146                 // Default return value on error
 147                 $headerValue = null;
 148
 149                 // Construct the name
 150                 $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));
 151
 152                 // Does this header exist?
 153                 if (isset($_SERVER[$name])) {
 154                         $headerValue = $_SERVER[$name];
 155                 } // END - if
 156
 157                 // Return the value
 158                 return $headerValue;
 159         }
 160
 161         /**
 162          * Getter for request method. This getter might be useful for security filters
 163          *
 164          * @return      $requestMethod  Used request method
 165          */
 166         public final function getRequestMethod () {
 167                 return $_SERVER['REQUEST_METHOD'];
 168         }
 169
 170         /**
 171          * Sets wether the request was valid (default: true)
 172          *
 173          * @param       $isValid        Wether the request is valid
 174          * @return      void
 175          */
 176         public final function requestIsValid ($isValid = true) {
 177                 $this->requestIsValid = (bool) $isValid;
 178         }
 179
 180         /**
 181          * Returns wether this request is valid
 182          *
 183          * @return      $requestIsValid         Wether this request is valid
 184          */
 185         public final function isRequestValid () {
 186                 return $this->requestIsValid;
 187         }
 188
 189         /**
 190          * Reads a cookie and returns it's value or null if not found
 191          *
 192          * @param       $cookieName             Name of cookie we shall read
 193          * @return      $cookieValue    Value of cookie or null if not found
 194          */
 195         public final function readCookie ($cookieName) {
 196                 // Default is no cookie with that name found
 197                 $cookieValue = null;
 198
 199                 // Is the cookie set?
 200                 if (isset($_COOKIE[$cookieName])) {
 201                         // Then get it
 202                         $cookieValue = $_COOKIE[$cookieName];
 203                 } // END - if
 204
 205                 // Return the value
 206                 return $cookieValue;
 207         }
 208 }
 209
 210 // [EOF]
 211 ?>