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          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set part description
  40                 $this->setObjectDescription("HTTP-Anfrage");
  41
  42                 // Create unique ID number
  43                 $this->createUniqueID();
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47                 $this->removeSystemArray();
  48         }
  49
  50         /**
  51          * Creates an instance of this class and prepares it a little
  52          *
  53          * @return      $httpInstance   An instance of this class
  54          */
  55         public final static function createHttpRequest () {
  56                 // Create an instance
  57                 $httpInstance = new HttpRequest();
  58
  59                 // Prepare the HTTP request data for usage
  60                 $httpInstance->prepareRequestData();
  61
  62                 // Return the prepared instance
  63                 return $httpInstance;
  64         }
  65
  66         /**
  67          * Prepares the HTTP request data for usage by currently copying
  68          * $_REQUEST into a private attribute. Later on we can add more
  69          * things for initialization here.
  70          *
  71          * @return      void
  72          */
  73         public function prepareRequestData () {
  74                 // Copy the $_REQUEST array
  75                 $this->requestData = $_REQUEST;
  76         }
  77
  78         /**
  79          * Checks wether a request element is set
  80          * @param       $element        Name of the request element we want to check
  81          * @return      $isSet          Wether the request element is set
  82          * @throws      MissingArrayElementsException   Thrown if a request element is not set
  83          */
  84         public function isRequestElementSet ($element) {
  85                 // Is this element found?
  86                 if (!isset($this->requestData[$element])) {
  87                         // Then throw an exception
  88                         throw new MissingArrayElementsException(array($this, 'requestData', $element), self::EXCEPTION_MISSING_ELEMENT);
  89                 }
  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                 try {
 107                         if ($this->isRequestElementSet($element)) {
 108                                 $value = $this->requestData[$element];
 109                         }
 110                 } catch (MissingArrayElementsException $e) {
 111                         // Do nothing here
 112                 }
 113
 114                 // Return the element's value
 115                 return $value;
 116         }
 117
 118         /**
 119          * Wrapper method for array_key() function for the request data array
 120          *
 121          * @return      $array  An array containing all array keys to return
 122          */
 123         public function getParameterNames () {
 124                 return array_keys($this->requestData);
 125         }
 126
 127         /**
 128          * Getter for a header element or 'null' if the header was not found
 129          *
 130          * @param       $headerName             Name of the header
 131          * @return      $headerValue    Value of the header or 'null' if not found
 132          */
 133         public function getHeader ($headerName) {
 134                 // Default return value on error
 135                 $headerValue = null;
 136
 137                 // Construct the name
 138                 $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));
 139
 140                 // Does this header exist?
 141                 if (isset($_SERVER[$name])) {
 142                         $headerValue = $_SERVER[$name];
 143                 }
 144
 145                 // Return the value
 146                 return $headerValue;
 147         }
 148 }
 149
 150 // [EOF]
 151 ?>