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-Anfrage");
  48
  49                 // Create unique ID number
  50                 $this->createUniqueID();
  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                 }
  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                         }
 117                 } catch (MissingArrayElementsException $e) {
 118                         // Do nothing here
 119                 }
 120
 121                 // Return the element's value
 122                 return $value;
 123         }
 124
 125         /**
 126          * Wrapper method for array_key() function for the request data array
 127          *
 128          * @return      $array  An array containing all array keys to return
 129          */
 130         public function getParameterNames () {
 131                 return array_keys($this->requestData);
 132         }
 133
 134         /**
 135          * Getter for a header element or 'null' if the header was not found
 136          *
 137          * @param       $headerName             Name of the header
 138          * @return      $headerValue    Value of the header or 'null' if not found
 139          */
 140         public function getHeader ($headerName) {
 141                 // Default return value on error
 142                 $headerValue = null;
 143
 144                 // Construct the name
 145                 $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));
 146
 147                 // Does this header exist?
 148                 if (isset($_SERVER[$name])) {
 149                         $headerValue = $_SERVER[$name];
 150                 }
 151
 152                 // Return the value
 153                 return $headerValue;
 154         }
 155
 156         /**
 157          * Getter for request method. This getter might be useful for security filters
 158          *
 159          * @return      $requestMethod  Used request method
 160          */
 161         public final function getRequestMethod () {
 162                 return $_SERVER['REQUEST_METHOD'];
 163         }
 164
 165         /**
 166          * Sets wether the request was valid (default: true)
 167          *
 168          * @param       $isValid                Wether the request is valid
 169          * @return      void
 170          */
 171         public final function requestIsValid ($isValid = true) {
 172                 $this->requestIsValid = (bool) $isValid;
 173         }
 174
 175         /**
 176          * Returns wether this request is valid
 177          *
 178          * @return      $requestIsValid         Wether this request is valid
 179          */
 180         public final function isRequestValid () {
 181                 return $this->requestIsValid;
 182         }
 183 }
 184
 185 // [EOF]
 186 ?>