RequestInterface.php
5.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<?php
namespace Phalcon\Http {
/**
* Phalcon\Http\RequestInterface initializer
*/
interface RequestInterface {
/**
* Gets a variable from the $_REQUEST superglobal applying filters if needed
*
* @param string $name
* @param string|array $filters
* @param mixed $defaultValue
* @return mixed
*/
public function get($name=null, $filters=null, $defaultValue=null);
/**
* Gets a variable from the $_POST superglobal applying filters if needed
*
* @param string $name
* @param string|array $filters
* @param mixed $defaultValue
* @return mixed
*/
public function getPost($name=null, $filters=null, $defaultValue=null);
/**
* Gets variable from $_GET superglobal applying filters if needed
*
* @param string $name
* @param string|array $filters
* @param mixed $defaultValue
* @return mixed
*/
public function getQuery($name=null, $filters=null, $defaultValue=null);
/**
* Gets variable from $_SERVER superglobal
*
* @param string $name
* @return mixed
*/
public function getServer($name);
/**
* Checks whether $_SERVER superglobal has certain index
*
* @param string $name
* @return boolean
*/
public function has($name);
/**
* Checks whether $_POST superglobal has certain index
*
* @param string $name
* @return boolean
*/
public function hasPost($name);
/**
* Checks whether $_SERVER superglobal has certain index
*
* @param string $name
* @return boolean
*/
public function hasQuery($name);
/**
* Checks whether $_SERVER superglobal has certain index
*
* @param string $name
* @return mixed
*/
public function hasServer($name);
/**
* Gets HTTP header from request data
*
* @param string $header
* @return string
*/
public function getHeader($header);
/**
* Gets HTTP schema (http/https)
*
* @return string
*/
public function getScheme();
/**
* Checks whether request has been made using ajax. Checks if $_SERVER['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'
*
* @return boolean
*/
public function isAjax();
/**
* Checks whether request has been made using SOAP
*
* @return boolean
*/
public function isSoapRequested();
/**
* Checks whether request has been made using any secure layer
*
* @return boolean
*/
public function isSecureRequest();
/**
* Gets HTTP raws request body
*
* @return string
*/
public function getRawBody();
/**
* Gets active server address IP
*
* @return string
*/
public function getServerAddress();
/**
* Gets active server name
*
* @return string
*/
public function getServerName();
/**
* Gets information about schema, host and port used by the request
*
* @return string
*/
public function getHttpHost();
/**
* Gets most possibly client IPv4 Address. This methods search in $_SERVER['REMOTE_ADDR'] and optionally in $_SERVER['HTTP_X_FORWARDED_FOR']
*
* @param boolean $trustForwardedHeader
* @return string
*/
public function getClientAddress($trustForwardedHeader=null);
/**
* Gets HTTP method which request has been made
*
* @return string
*/
public function getMethod();
/**
* Gets HTTP user agent used to made the request
*
* @return string
*/
public function getUserAgent();
/**
* Check if HTTP method match any of the passed methods
*
* @param string|array $methods
* @return boolean
*/
public function isMethod($methods);
/**
* Checks whether HTTP method is POST. if $_SERVER['REQUEST_METHOD']=='POST'
*
* @return boolean
*/
public function isPost();
/**
*
* Checks whether HTTP method is GET. if $_SERVER['REQUEST_METHOD']=='GET'
*
* @return boolean
*/
public function isGet();
/**
* Checks whether HTTP method is PUT. if $_SERVER['REQUEST_METHOD']=='PUT'
*
* @return boolean
*/
public function isPut();
/**
* Checks whether HTTP method is HEAD. if $_SERVER['REQUEST_METHOD']=='HEAD'
*
* @return boolean
*/
public function isHead();
/**
* Checks whether HTTP method is DELETE. if $_SERVER['REQUEST_METHOD']=='DELETE'
*
* @return boolean
*/
public function isDelete();
/**
* Checks whether HTTP method is OPTIONS. if $_SERVER['REQUEST_METHOD']=='OPTIONS'
*
* @return boolean
*/
public function isOptions();
/**
* Checks whether request include attached files
*
* @param boolean $notErrored
* @return boolean
*/
public function hasFiles($notErrored=null);
/**
* Gets attached files as \Phalcon\Http\Request\FileInterface compatible instances
*
* @param boolean $notErrored
* @return \Phalcon\Http\Request\FileInterface[]
*/
public function getUploadedFiles($notErrored=null);
/**
* Gets web page that refers active request. ie: http://www.google.com
*
* @return string
*/
public function getHTTPReferer();
/**
* Gets array with mime/types and their quality accepted by the browser/client from $_SERVER['HTTP_ACCEPT']
*
* @return array
*/
public function getAcceptableContent();
/**
* Gets best mime/type accepted by the browser/client from $_SERVER['HTTP_ACCEPT']
*
* @return array
*/
public function getBestAccept();
/**
* Gets charsets array and their quality accepted by the browser/client from $_SERVER['HTTP_ACCEPT_CHARSET']
*
* @return array
*/
public function getClientCharsets();
/**
* Gets best charset accepted by the browser/client from $_SERVER['HTTP_ACCEPT_CHARSET']
*
* @return string
*/
public function getBestCharset();
/**
* Gets languages array and their quality accepted by the browser/client from $_SERVER['HTTP_ACCEPT_LANGUAGE']
*
* @return array
*/
public function getLanguages();
/**
* Gets best language accepted by the browser/client from $_SERVER['HTTP_ACCEPT_LANGUAGE']
*
* @return string
*/
public function getBestLanguage();
}
}