inc/classes/main/request/web/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, 2009 Core Developer Team
   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 BaseRequest implements Requestable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class and prepares it a little
  37          *
  38          * @return      $httpInstance   An instance of this class
  39          */
  40         public final static function createHttpRequest () {
  41                 // Create an instance
  42                 $httpInstance = new HttpRequest();
  43
  44                 // Prepare the HTTP request data for usage
  45                 $httpInstance->prepareRequestData();
  46
  47                 // Return the prepared instance
  48                 return $httpInstance;
  49         }
  50
  51         /**
  52          * Prepares the HTTP request data for usage by currently copying
  53          * $_REQUEST into a private attribute. Later on we can add more
  54          * things for initialization here.
  55          *
  56          * @return      void
  57          */
  58         public function prepareRequestData () {
  59                 // Copy GET then POST data
  60                 $this->setRequestData(array_merge($_GET, $_POST));
  61         }
  62
  63         /**
  64          * Getter for a header element or 'null' if header was not found
  65          *
  66          * @param       $headerName             Name of the header
  67          * @return      $headerValue    Value of the header or 'null' if not found
  68          */
  69         public function getHeader ($headerName) {
  70                 // Default return value on error
  71                 $headerValue = null;
  72
  73                 // Construct the name
  74                 $name = 'HTTP_' . strtolower($this->convertDashesToUnderscores($headerName));
  75
  76                 // Does this header exist?
  77                 if (isset($_SERVER[$name])) {
  78                         $headerValue = $_SERVER[$name];
  79                 } // END - if
  80
  81                 // Return the value
  82                 return $headerValue;
  83         }
  84
  85         /**
  86          * Getter for request method. This getter might be useful for security filters
  87          *
  88          * @return      $requestMethod  Used request method
  89          */
  90         public final function getRequestMethod () {
  91                 return $_SERVER['REQUEST_METHOD'];
  92         }
  93
  94         /**
  95          * Reads a cookie and returns it's value or null if not found
  96          *
  97          * @param       $cookieName             Name of cookie we shall read
  98          * @return      $cookieValue    Value of cookie or null if not found
  99          */
 100         public final function readCookie ($cookieName) {
 101                 // Default is no cookie with that name found
 102                 $cookieValue = null;
 103
 104                 // Is the cookie set?
 105                 if (isset($_COOKIE[$cookieName])) {
 106                         // Then get it
 107                         $cookieValue = $_COOKIE[$cookieName];
 108                 } // END - if
 109
 110                 // Return the value
 111                 return $cookieValue;
 112         }
 113 }
 114
 115 // [EOF]
 116 ?>