3 * A concrete request class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 ???Request 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 create???Request () {
42 $httpInstance = new ???Request();
44 // Prepare the HTTP request data for usage
45 $httpInstance->prepareRequestData();
47 // Return the prepared instance
52 * Prepares the request data for usage
55 * @todo Needs to be implemented
57 public function prepareRequestData () {
58 $this->partialStub("Please implement this method.");
62 * Getter for a header element or 'null' if header was not found
64 * @param $headerName Name of the header
65 * @return $headerValue Value of the header or 'null' if not found
67 public function getHeaderElement ($headerName) {
68 $this->partialStub("Please implement this method.");
72 * Getter for request method. This getter might be useful for security filters
74 * @return $requestMethod Used request method
76 public final function getRequestMethod () {
77 $this->partialStub("Please implement this method.");
78 return $_SERVER['REQUEST_METHOD'];
82 * Reads a cookie and returns it's value or null if not found
84 * @param $cookieName Name of cookie we shall read
85 * @return $cookieValue Value of cookie or null if not found
87 public final function readCookie ($cookieName) {
88 $this->partialStub("Please implement this method.");