3 * A concrete request class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 ConsoleRequest 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 static final function createConsoleRequest () {
42 $httpInstance = new ConsoleRequest();
44 // Prepare the console 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 // Get the "request data" from the command-line argument list
59 $args = $_SERVER['argv'];
61 // Are there less than two parameters?
62 if ($_SERVER['argc'] < 2) {
67 // Is the first element "index.php" ?
68 if ($args[0] == 'index.php') {
73 // Try to determine next parameters
74 foreach ($args as $arg) {
75 // Seperate arguemnt name from value
76 $argArray = explode('=', $arg);
78 // Is the second one set?
79 if (!isset($argArray[1])) {
80 // Add it likewise, but empty value
81 $this->setRequestElement($argArray[0], '');
83 // Set a name=value pair escaped and secured
84 $this->setRequestElement($argArray[0], escapeshellcmd($argArray[1]));
90 * Getter for a header element or 'null' if header was not found
92 * @param $headerName Name of the header
93 * @return $headerValue Value of the header or 'null' if not found
95 public function getHeader ($headerName) {
96 $this->partialStub('Please implement this method.');
100 * Getter for request method. This getter might be useful for security filters
102 * @return $requestMethod Used request method
104 public final function getRequestMethod () {
109 * Reads a cookie and returns it's value or null if not found
111 * @param $cookieName Name of cookie we shall read
112 * @return $cookieValue Value of cookie or null if not found
114 public final function readCookie ($cookieName) {
115 // @TODO There are no cookies on console