interface IRequest

IHttpRequest provides access scheme for request sent via HTTP.

Constants

GET

HTTP request method

POST

HTTP request method

HEAD

HTTP request method

PUT

HTTP request method

DELETE

HTTP request method

PATCH

HTTP request method

OPTIONS

HTTP request method

Methods

getUrl()

Returns URL object.

mixed
getQuery(string $key = null)

Returns variable provided to the script via URL query ($_GET).

mixed
getPost(string $key = null)

Returns variable provided to the script via POST method ($_POST).

FileUpload|array|null
getFile(string $key)

Returns uploaded file.

array
getFiles()

Returns uploaded files.

mixed
getCookie(string $key)

Returns variable provided to the script via HTTP cookies.

array
getCookies()

Returns variables provided to the script via HTTP cookies.

string
getMethod()

Returns HTTP request method (GET, POST, HEAD, PUT, .

bool
isMethod(string $method)

Checks HTTP request method.

string|null
getHeader(string $header)

Return the value of the HTTP header. Pass the header name as the plain, HTTP-specified header name (e.g. 'Accept-Encoding').

array
getHeaders()

Returns all HTTP headers.

bool
isSecured()

Is the request sent via secure channel (https)?

bool
isAjax()

Is AJAX request?

string|null
getRemoteAddress()

Returns the IP address of the remote client.

string|null
getRemoteHost()

Returns the host of the remote client.

string|null
getRawBody()

Returns raw content of HTTP request body.

UrlImmutable|null
getReferer()

Returns referrer.

bool
isSameSite()

Is the request sent from the same origin?

Details

at line 33
UrlScript getUrl()

Returns URL object.

Return Value

UrlScript

at line 42
mixed getQuery(string $key = null)

Returns variable provided to the script via URL query ($_GET).

If no key is passed, returns the entire array.

Parameters

string $key

Return Value

mixed

at line 49
mixed getPost(string $key = null)

Returns variable provided to the script via POST method ($_POST).

If no key is passed, returns the entire array.

Parameters

string $key

Return Value

mixed

at line 55
FileUpload|array|null getFile(string $key)

Returns uploaded file.

Parameters

string $key

Return Value

FileUpload|array|null

at line 60
array getFiles()

Returns uploaded files.

Return Value

array

at line 66
mixed getCookie(string $key)

Returns variable provided to the script via HTTP cookies.

Parameters

string $key

Return Value

mixed

at line 71
array getCookies()

Returns variables provided to the script via HTTP cookies.

Return Value

array

at line 78
string getMethod()

Returns HTTP request method (GET, POST, HEAD, PUT, .

..). The method is case-sensitive.

Return Value

string

at line 83
bool isMethod(string $method)

Checks HTTP request method.

Parameters

string $method

Return Value

bool

at line 89
string|null getHeader(string $header)

Return the value of the HTTP header. Pass the header name as the plain, HTTP-specified header name (e.g. 'Accept-Encoding').

Parameters

string $header

Return Value

string|null

at line 94
array getHeaders()

Returns all HTTP headers.

Return Value

array

at line 99
bool isSecured()

Is the request sent via secure channel (https)?

Return Value

bool

at line 104
bool isAjax()

Is AJAX request?

Return Value

bool

at line 109
string|null getRemoteAddress()

Returns the IP address of the remote client.

Return Value

string|null

at line 114
string|null getRemoteHost()

Returns the host of the remote client.

Return Value

string|null

at line 119
string|null getRawBody()

Returns raw content of HTTP request body.

Return Value

string|null

at line 18
UrlImmutable|null getReferer()

Returns referrer.

Return Value

UrlImmutable|null

at line 18
bool isSameSite()

Is the request sent from the same origin?

Return Value

bool