3 namespace CoreFramework\Request;
6 * A concrete request class
8 * @author Roland Haeder <webmaster@ship-simu.org>
10 <<<<<<< HEAD:framework/main/classes/request/class_
11 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
14 >>>>>>> Some updates::inc/main/classes/request/class_
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.ship-simu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class ???Request extends BaseRequest implements Requestable {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of this class and prepares it a little
45 * @return $requestInstance An instance of this class
47 public final static function create???Request () {
49 $requestInstance = new ???Request();
51 // Prepare the HTTP request data for usage
52 $requestInstance->prepareRequestData();
54 // Return the prepared instance
55 return $requestInstance;
59 * Prepares the request data for usage
62 * @todo Needs to be implemented
64 protected function prepareRequestData () {
65 $this->partialStub("Please implement this method.");
69 * Getter for a header element or 'null' if header was not found
71 * @param $headerName Name of the header
72 * @return $headerValue Value of the header or 'null' if not found
74 public function getHeaderElement ($headerName) {
75 $this->partialStub("Please implement this method.");
79 * Getter for request method. This getter might be useful for security filters
81 * @return $requestMethod Used request method
83 public final function getRequestMethod () {
84 $this->partialStub("Please implement this method.");
85 return $_SERVER['REQUEST_METHOD'];
89 * Reads a cookie and returns it's value or null if not found
91 * @param $cookieName Name of cookie we shall read
92 * @return $cookieValue Value of cookie or null if not found
94 public final function readCookie ($cookieName) {
95 $this->partialStub("Please implement this method.");