3 * A concrete and secured HTTP request class to make HTTP requests more abstract
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class HttpRequest extends BaseRequest implements Requestable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class and prepares it a little
38 * @return $httpInstance An instance of this class
40 public final static function createHttpRequest () {
42 $httpInstance = new HttpRequest();
44 // Prepare the HTTP request data for usage
45 $httpInstance->prepareRequestData();
47 // Return the prepared instance
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.
58 public function prepareRequestData () {
59 // Copy GET then POST data
60 $this->setRequestData(array_merge($_GET, $_POST));
64 * Getter for a header element or 'null' if header was not found
66 * @param $headerName Name of the header
67 * @return $headerValue Value of the header or 'null' if not found
69 public function getHeader ($headerName) {
70 // Default return value on error
74 $name = 'HTTP_' . strtolower($this->convertDashesToUnderscores($headerName));
76 // Does this header exist?
77 if (isset($_SERVER[$name])) {
78 $headerValue = $_SERVER[$name];
86 * Getter for request method. This getter might be useful for security filters
88 * @return $requestMethod Used request method
90 public final function getRequestMethod () {
91 return $_SERVER['REQUEST_METHOD'];
95 * Reads a cookie and returns it's value or null if not found
97 * @param $cookieName Name of cookie we shall read
98 * @return $cookieValue Value of cookie or null if not found
100 public final function readCookie ($cookieName) {
101 // Default is no cookie with that name found
104 // Is the cookie set?
105 if (isset($_COOKIE[$cookieName])) {
107 $cookieValue = $_COOKIE[$cookieName];