Copyright updated, interface RenderableMenu added
[core.git] / inc / classes / main / request / 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 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                 // Clean up a little
47                 $this->removeNumberFormaters();
48                 $this->removeSystemArray();
49         }
50
51         /**
52          * Creates an instance of this class and prepares it a little
53          *
54          * @return      $httpInstance   An instance of this class
55          */
56         public final static function createHttpRequest () {
57                 // Create an instance
58                 $httpInstance = new HttpRequest();
59
60                 // Prepare the HTTP request data for usage
61                 $httpInstance->prepareRequestData();
62
63                 // Return the prepared instance
64                 return $httpInstance;
65         }
66
67         /**
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.
71          *
72          * @return      void
73          */
74         public function prepareRequestData () {
75                 // Copy GET then POST data
76                 $this->requestData = array_merge($_GET, $_POST);
77         }
78
79         /**
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
83          */
84         public function isRequestElementSet ($element) {
85                 // Is this element found?
86                 $isSet = isset($this->requestData[$element]);
87
88                 // Return result
89                 return $isSet;
90         }
91
92         /**
93          * Getter for request element or 'null' if element was not found
94          *
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
98          */
99         public function getRequestElement ($element) {
100                 // Initialize value
101                 $value = null;
102
103                 // Is the element set?
104                 if ($this->isRequestElementSet($element)) {
105                         // Get the bare value
106                         $value = $this->requestData[$element];
107
108                         // Secure it against attacks
109                         $value = htmlentities(strip_tags($value), ENT_QUOTES);
110                 } // END - if
111
112                 // Return the element's value
113                 return $value;
114         }
115
116         /**
117          * Setter for request elements
118          *
119          * @param       $element        Request element to se
120          * @param       $value          Value to set
121          * @return      void
122          */
123         public function setRequestElement ($element, $value) {
124                 $this->requestData[$element] = $value;
125         }
126
127         /**
128          * Wrapper method for array_key() function for the request data array
129          *
130          * @return      $array  An array containing all array keys to return
131          */
132         public function getParameterNames () {
133                 return array_keys($this->requestData);
134         }
135
136         /**
137          * Getter for a header element or 'null' if header was not found
138          *
139          * @param       $headerName             Name of the header
140          * @return      $headerValue    Value of the header or 'null' if not found
141          */
142         public function getHeader ($headerName) {
143                 // Default return value on error
144                 $headerValue = null;
145
146                 // Construct the name
147                 $name = 'HTTP_' . strtolower($this->convertDashesToUnderscores($headerName));
148
149                 // Does this header exist?
150                 if (isset($_SERVER[$name])) {
151                         $headerValue = $_SERVER[$name];
152                 } // END - if
153
154                 // Return the value
155                 return $headerValue;
156         }
157
158         /**
159          * Getter for request method. This getter might be useful for security filters
160          *
161          * @return      $requestMethod  Used request method
162          */
163         public final function getRequestMethod () {
164                 return $_SERVER['REQUEST_METHOD'];
165         }
166
167         /**
168          * Sets wether the request was valid (default: true)
169          *
170          * @param       $isValid        Wether the request is valid
171          * @return      void
172          */
173         public final function requestIsValid ($isValid = true) {
174                 $this->requestIsValid = (bool) $isValid;
175         }
176
177         /**
178          * Returns wether this request is valid
179          *
180          * @return      $requestIsValid         Wether this request is valid
181          */
182         public final function isRequestValid () {
183                 return $this->requestIsValid;
184         }
185
186         /**
187          * Reads a cookie and returns it's value or null if not found
188          *
189          * @param       $cookieName             Name of cookie we shall read
190          * @return      $cookieValue    Value of cookie or null if not found
191          */
192         public final function readCookie ($cookieName) {
193                 // Default is no cookie with that name found
194                 $cookieValue = null;
195
196                 // Is the cookie set?
197                 if (isset($_COOKIE[$cookieName])) {
198                         // Then get it
199                         $cookieValue = $_COOKIE[$cookieName];
200                 } // END - if
201
202                 // Return the value
203                 return $cookieValue;
204         }
205 }
206
207 // [EOF]
208 ?>