c349798673d66edeb1187907e4fbfbe20f52220f
[core.git] / inc / classes / interfaces / request / class_Requestable.php
1 <?php
2 /**
3  * An interface for requests
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 interface Requestable extends FrameworkInterface {
25         /**
26          * Prepares the HTTP request data for usage by currently copying
27          * $_REQUEST into a private attribute. Later on we can add more
28          * things for initialization here.
29          *
30          * @return      void
31          */
32         function prepareRequestData ();
33
34         /**
35          * Checks wether a request element is set
36          * @param       $element        Name of the request element we want to check
37          * @return      $isSet          Wether the request element is set
38          * @throws      MissingArrayElementsException   Thrown if a request element is not set
39          */
40         function isRequestElementSet ($element);
41
42         /**
43          * Getter for request element or 'null' if element was not found
44          *
45          * @param       $element        Name of the request element we want to check
46          * @return      $value          Value of the found request element or 'null' if the
47          *                                              element was not found
48          */
49         function getRequestElement ($element);
50
51         /**
52          * Wrapper method for array_key() function for the request data array
53          *
54          * @return      $array  An array containing all array keys to return
55          */
56         function getParameterNames ();
57
58         /**
59          * Getter for a header element or 'null' if header was not found
60          *
61          * @param       $headerName             Name of the header
62          * @return      $headerValue    Value of the header or 'null' if not found
63          */
64         function getHeader ($headerName);
65
66         /**
67          * Sets wether the request was valid (default: true)
68          *
69          * @param       $isValid                Wether the request is valid
70          * @return      void
71          */
72         function requestIsValid ($isValid = true);
73
74         /**
75          * Reads a cookie and returns it's value or null if not found
76          *
77          * @param       $cookieName             Name of cookie we shall read
78          * @return      $cookieValue    Value of cookie or null if not found
79          */
80         function readCookie ($cookieName);
81 }
82
83 //
84 ?>