3 * An interface for requests
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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 interface Requestable extends FrameworkInterface {
26 * Prepares the request data for usage
30 function prepareRequestData ();
33 * Checks whether a request element is set
35 * @param $element Name of the request element we want to check
36 * @return $isSet Whether the request element is set
37 * @throws MissingArrayElementsException Thrown if a request element is not set
39 function isRequestElementSet ($element);
42 * Getter for request element or 'null' if element was not found
44 * @param $element Name of the request element we want to check
45 * @return $value Value of the found request element or 'null' if the
46 * element was not found
48 function getRequestElement ($element);
51 * Wrapper method for array_key() function for the request data array
53 * @return $array An array containing all array keys to return
55 function getParameterNames ();
58 * Getter for a header element or 'null' if header was not found
60 * @param $headerName Name of the header
61 * @return $headerValue Value of the header or 'null' if not found
63 function getHeader ($headerName);
66 * Sets whether the request was valid (default: TRUE)
68 * @param $isValid Whether the request is valid
71 function requestIsValid ($isValid = TRUE);
74 * Reads a cookie and returns it's value or null if not found
76 * @param $cookieName Name of cookie we shall read
77 * @return $cookieValue Value of cookie or null if not found
79 function readCookie ($cookieName);