-
Notifications
You must be signed in to change notification settings - Fork 0
/
RequestInterface.php
128 lines (112 loc) · 2.74 KB
/
RequestInterface.php
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
<?php
namespace HZ\Contracts\Http;
use ArrayAccess;
interface RequestInterface extends ArrayAccess
{
/**
* Get value from the query parameters ie from _GET global variable
* If not exists, return null
*
* @param string $input
* @return mixed
*/
public function get(string $input);
/**
* Get value from the request body ie from _POST global variable
* If not exists, return null
*
* @param string $input
* @return mixed
*/
public function post(string $input);
/**
* Get value from the _SERVER global variable
* If not exists, return null
*
* @param string $key
* @return string
*/
public function server(string $key): string;
/**
* Get a request header value for the given header
*
* @param string $header
* @return string
*/
public function header(string $header): string;
/**
* Get all request headers
*
* @return array
*/
public function headers(): array;
/**
* Get value from the _FILES global variable
* If not exists, return null, otherwise return new object of UploadedFile
*
* @param string $key
* @return UploadedFile
*/
public function file(string $key):? UploadedFile;
/**
* Check if the given input name is uploaded
*
* @param string $input
* @return mixed
*/
public function isFile(string $input): bool;
/**
* Get the current route
*
* @return string
*/
public function route(): string;
/**
* Validate the given inputs by the given rules
* Rules are listed in array
* Returns array contains the input name and the value is the error message
* If all rules are valid, return true
*
* @param array $rules
* @return array|true
*/
public function validate(array $rules);
/**
* Determine if current request is served by https request
*
* @return bool
*/
public function isSecure(): bool;
/**
* Get current ip
*
* @return string
*/
public function ip(): string;
/**
* Get user agent
*
* @return string
*/
public function userAgent(): string;
/**
* Get current uri
* i.e /users
*
* @return string
*/
public function uri(): string;
/**
* Get current full url of the request
*
* @return string
*/
public function url(): string;
/**
* Access any request value either from _GET, _POST or _FILES variables dynamically
*
* @param string $key
* @return mixed
*/
public function __get(string $key);
}