]> git.mxchange.org Git - core.git/blob - framework/main/classes/request/html/class_HtmlRequest.php
Continued:
[core.git] / framework / main / classes / request / html / class_HtmlRequest.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Request;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Request\Requestable;
7
8 /**
9  * A concrete and secured HTML request class to make HTML requests more abstract
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.org
16  * @todo                Move out the cookie part to a seperate class, e.g. Cookie
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class HtmlRequest extends BaseRequest implements Requestable {
32         /**
33          * Protected constructor
34          *
35          * @return      void
36          */
37         protected function __construct () {
38                 // Call parent constructor
39                 parent::__construct(__CLASS__);
40         }
41
42         /**
43          * Creates an instance of this class and prepares it a little
44          *
45          * @return      $requestInstance        An instance of this class
46          */
47         public static final function createHtmlRequest () {
48                 // Create an instance
49                 $requestInstance = new HtmlRequest();
50
51                 // Prepare the HTML request data for usage
52                 $requestInstance->prepareRequestData();
53
54                 // Return the prepared instance
55                 return $requestInstance;
56         }
57
58         /**
59          * Checks if the request method is GET.
60          *
61          * @return      $isGet  Whether the request method is GET
62          */
63         public function isGetRequestMethod () {
64                 // Check it
65                 return ($this->getRequestMethod() == 'GET');
66         }
67
68         /**
69          * Checks if the request method is HEAD.
70          *
71          * @return      $isHead         Whether the request method is HEAD
72          */
73         public function isHeadRequestMethod () {
74                 // Check it
75                 return ($this->getRequestMethod() == 'HEAD');
76         }
77
78         /**
79          * Checks if the request method is POST.
80          *
81          * @return      $isPost         Whether the request method is POST
82          */
83         public function isPostRequestMethod () {
84                 // Check it
85                 return ($this->getRequestMethod() == 'POST');
86         }
87
88         /**
89          * Prepares the HTML request data for usage by currently copying
90          * $_REQUEST into a private attribute. Later on we can add more
91          * things for initialization here.
92          *
93          * @return      void
94          */
95         protected function prepareRequestData () {
96                 // Copy GET then POST data
97                 $this->setRequestData(array_merge($_GET, $_POST));
98         }
99
100         /**
101          * Getter for a header element or 'null' if header was not found
102          *
103          * @param       $headerName             Name of the header
104          * @return      $headerValue    Value of the header or 'null' if not found
105          */
106         public function getHeaderElement ($headerName) {
107                 // Default return value on error
108                 $headerValue = NULL;
109
110                 // Construct the name
111                 $name = 'HTTP_' . strtoupper(self::convertDashesToUnderscores($headerName));
112
113                 // Does this header exist?
114                 if (isset($_SERVER[$name])) {
115                         $headerValue = $_SERVER[$name];
116                 } // END - if
117
118                 // Return the value
119                 return $headerValue;
120         }
121
122         /**
123          * Getter for request method. This getter might be useful for security filters
124          *
125          * @return      $requestMethod  Used request method
126          */
127         public final function getRequestMethod () {
128                 return $_SERVER['REQUEST_METHOD'];
129         }
130
131         /**
132          * Reads a cookie and returns it's value or null if not found
133          *
134          * @param       $cookieName             Name of cookie we shall read
135          * @return      $cookieValue    Value of cookie or null if not found
136          */
137         public final function readCookie ($cookieName) {
138                 // Default is no cookie with that name found
139                 $cookieValue = NULL;
140
141                 // Is the cookie set?
142                 if (isset($_COOKIE[$cookieName])) {
143                         // Then get it
144                         $cookieValue = $_COOKIE[$cookieName];
145                 } // END - if
146
147                 // Return the value
148                 return $cookieValue;
149         }
150
151 }