Request class rewritten to extend BaseRequest class, ConsoleRequest added
[core.git] / inc / classes / main / request / class_
1 <?php
2 /**
3  * A concrete request class
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 class ???Request extends BaseRequest implements Requestable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class and prepares it a little
37          *
38          * @return      $httpInstance   An instance of this class
39          */
40         public final static function create???Request () {
41                 // Create an instance
42                 $httpInstance = new ???Request();
43
44                 // Prepare the HTTP request data for usage
45                 $httpInstance->prepareRequestData();
46
47                 // Return the prepared instance
48                 return $httpInstance;
49         }
50
51         /**
52          * Prepares the request data for usage
53          *
54          * @return      void
55          * @todo        Needs to be implemented
56          */
57         public function prepareRequestData () {
58                 $this->partialStub("Please implement this method.");
59         }
60
61         /**
62          * Getter for a header element or 'null' if header was not found
63          *
64          * @param       $headerName             Name of the header
65          * @return      $headerValue    Value of the header or 'null' if not found
66          */
67         public function getHeader ($headerName) {
68                 $this->partialStub("Please implement this method.");
69         }
70
71         /**
72          * Getter for request method. This getter might be useful for security filters
73          *
74          * @return      $requestMethod  Used request method
75          */
76         public final function getRequestMethod () {
77                 $this->partialStub("Please implement this method.");
78                 return $_SERVER['REQUEST_METHOD'];
79         }
80
81         /**
82          * Reads a cookie and returns it's value or null if not found
83          *
84          * @param       $cookieName             Name of cookie we shall read
85          * @return      $cookieValue    Value of cookie or null if not found
86          */
87         public final function readCookie ($cookieName) {
88                 $this->partialStub("Please implement this method.");
89         }
90 }
91
92 // [EOF]
93 ?>