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, this is free software
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 BaseFrameworkSystem implements Requestable {
26 * Array for the request data
28 private $requestData = array();
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.
35 private $requestIsValid = true;
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
47 $this->removeNumberFormaters();
48 $this->removeSystemArray();
52 * Creates an instance of this class and prepares it a little
54 * @return $httpInstance An instance of this class
56 public final static function createHttpRequest () {
58 $httpInstance = new HttpRequest();
60 // Prepare the HTTP request data for usage
61 $httpInstance->prepareRequestData();
63 // Return the prepared instance
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.
74 public function prepareRequestData () {
75 // Copy GET then POST data
76 $this->requestData = array_merge($_GET, $_POST);
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
84 public function isRequestElementSet ($element) {
85 // Is this element found?
86 $isSet = isset($this->requestData[$element]);
93 * Getter for request element or 'null' if element was not found
95 * @param $element Name of the request element we want to check
96 * @return $value Value of the found request element or 'null' if the
97 * element was not found
99 public function getRequestElement ($element) {
103 // Is the element set?
104 if ($this->isRequestElementSet($element)) {
105 // Get the bare value
106 $value = $this->requestData[$element];
108 // Secure it against attacks
109 $value = htmlentities(strip_tags($value), ENT_QUOTES);
112 // Return the element's value
117 * Setter for request elements
119 * @param $element Request element to se
120 * @param $value Value to set
123 public function setRequestElement ($element, $value) {
124 $this->requestData[$element] = $value;
128 * Wrapper method for array_key() function for the request data array
130 * @return $array An array containing all array keys to return
132 public function getParameterNames () {
133 return array_keys($this->requestData);
137 * Getter for a header element or 'null' if header was not found
139 * @param $headerName Name of the header
140 * @return $headerValue Value of the header or 'null' if not found
142 public function getHeader ($headerName) {
143 // Default return value on error
146 // Construct the name
147 $name = 'HTTP_' . strtolower(str_replace('-', '_', $headerName));
149 // Does this header exist?
150 if (isset($_SERVER[$name])) {
151 $headerValue = $_SERVER[$name];
159 * Getter for request method. This getter might be useful for security filters
161 * @return $requestMethod Used request method
163 public final function getRequestMethod () {
164 return $_SERVER['REQUEST_METHOD'];
168 * Sets wether the request was valid (default: true)
170 * @param $isValid Wether the request is valid
173 public final function requestIsValid ($isValid = true) {
174 $this->requestIsValid = (bool) $isValid;
178 * Returns wether this request is valid
180 * @return $requestIsValid Wether this request is valid
182 public final function isRequestValid () {
183 return $this->requestIsValid;
187 * Reads a cookie and returns it's value or null if not found
189 * @param $cookieName Name of cookie we shall read
190 * @return $cookieValue Value of cookie or null if not found
192 public final function readCookie ($cookieName) {
193 // Default is no cookie with that name found
196 // Is the cookie set?
197 if (isset($_COOKIE[$cookieName])) {
199 $cookieValue = $_COOKIE[$cookieName];