3 * A concrete request class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 $consoleInstance An instance of this class
40 public static final function createConsoleRequest () {
42 $consoleInstance = new ConsoleRequest();
44 // Prepare the console request data for usage
45 $consoleInstance->prepareRequestData();
47 // Return the prepared instance
48 return $consoleInstance;
52 * Prepares the request data for usage
56 public function prepareRequestData () {
57 // 'argv' and 'argc' should be there
58 if ((!isset($_SERVER['argv'])) || (!isset($_SERVER['argc']))) {
59 // Maybe not right PHP mode? (needs CLI?)
60 trigger_error(sprintf('[%s:%d]: argv/argc not set: %s', __METHOD__, __LINE__, print_r($_SERVER, TRUE)), E_USER_ERROR);
63 // Get the "request data" from the command-line argument list
64 $args = $_SERVER['argv'];
66 // Are there less than two parameters?
67 if ($_SERVER['argc'] < 2) {
72 // Is the first element "index.php" ?
73 if ($args[0] == 'index.php') {
78 // Try to determine next parameters
79 foreach ($args as $arg) {
80 // Seperate arguemnt name from value
81 $argArray = explode('=', $arg);
83 // Is the second one set?
84 if (!isset($argArray[1])) {
85 // Add it likewise, but empty value
86 $this->setRequestElement($argArray[0], '');
88 // Set a name=value pair escaped and secured
89 $this->setRequestElement($argArray[0], escapeshellcmd($argArray[1]));
95 * Getter for a header element or 'null' if header was not found
97 * @param $headerName Name of the header
98 * @return $headerValue Value of the header or 'null' if not found
99 * @throws UnsupportedOperationException This method should never be called
101 public function getHeaderElement ($headerName) {
102 // Console doesn't have any headers
103 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
107 * Getter for request method. This getter might be useful for security filters
109 * @return $requestMethod Used request method
111 public final function getRequestMethod () {
112 // @TODO Can't this be 'CONSOLE' ?
117 * Reads a cookie and returns it's value or null if not found
119 * @param $cookieName Name of cookie we shall read
120 * @return $cookieValue Value of cookie or null if not found
121 * @throws UnsupportedOperationException This method should never be called
123 public final function readCookie ($cookieName) {
124 // There are no cookies on console
125 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
129 * Checks if the request method is GET.
131 * @return $isGet Whether the request method is GET
132 * @throws UnsupportedOperationException This method should never be called
134 public function isGetRequestMethod () {
135 // Not support method
136 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
140 * Checks if the request method is HEAD.
142 * @return $isHead Whether the request method is HEAD
143 * @throws UnsupportedOperationException This method should never be called
145 public function isHeadRequestMethod () {
146 // Not support method
147 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
151 * Checks if the request method is POST.
153 * @return $isPost Whether the request method is POST
154 * @throws UnsupportedOperationException This method should never be called
156 public function isPostRequestMethod () {
157 // Not support method
158 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);