class Request implements IRequest

HttpRequest provides access scheme for request sent via HTTP.

Methods

__construct(UrlScript $url, array $post = null, array $files = null, array $cookies = null, array $headers = null, string $method = null, string $remoteAddress = null, string $remoteHost = null, callable $rawBodyCallback = null)

No description

withUrl(UrlScript $url)

Returns a clone with a different URL.

getUrl()

Returns the URL of the request.

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 tree of upload files in a normalized structure, with each leaf an instance of Nette\Http\FileUpload.

mixed
getCookie(string $key)

Returns a cookie or null if it does not exist.

array
getCookies()

Returns all cookies.

string
getMethod()

Returns the HTTP method with which the request was made (GET, POST, HEAD, PUT, .

bool
isMethod(string $method)

Checks the HTTP method with which the request was made. The parameter is case-insensitive.

string|null
getHeader(string $header)

Returns an HTTP header or null if it does not exist. The parameter is case-insensitive.

array
getHeaders()

Returns all HTTP headers as associative array.

UrlImmutable|null
getReferer()

What URL did the user come from? Beware, it is not reliable at all.

bool
isSecured()

Is the request sent via secure channel (https)?

bool
isSameSite()

Is the request coming from the same site and is initiated by clicking on a link?

bool
isAjax()

Is it an 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.

string|null
detectLanguage(array $langs)

Returns the most preferred language by browser. Uses the Accept-Language header. If no match is reached, it returns null.

Details

at line 64
__construct(UrlScript $url, array $post = null, array $files = null, array $cookies = null, array $headers = null, string $method = null, string $remoteAddress = null, string $remoteHost = null, callable $rawBodyCallback = null)

Parameters

UrlScript $url
array $post
array $files
array $cookies
array $headers
string $method
string $remoteAddress
string $remoteHost
callable $rawBodyCallback

at line 91
Request withUrl(UrlScript $url)

Returns a clone with a different URL.

Parameters

UrlScript $url

Return Value

Request

at line 102
UrlScript getUrl()

Returns the URL of the request.

Return Value

UrlScript

at line 116
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 132
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 148
FileUpload|array|null getFile(string $key)

Returns uploaded file.

Parameters

string $key

Return Value

FileUpload|array|null

at line 158
array getFiles()

Returns tree of upload files in a normalized structure, with each leaf an instance of Nette\Http\FileUpload.

Return Value

array

at line 168
mixed getCookie(string $key)

Returns a cookie or null if it does not exist.

Parameters

string $key

Return Value

mixed

at line 180
array getCookies()

Returns all cookies.

Return Value

array

at line 192
string getMethod()

Returns the HTTP method with which the request was made (GET, POST, HEAD, PUT, .

..).

Return Value

string

at line 201
bool isMethod(string $method)

Checks the HTTP method with which the request was made. The parameter is case-insensitive.

Parameters

string $method

Return Value

bool

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

Returns an HTTP header or null if it does not exist. The parameter is case-insensitive.

Parameters

string $header

Return Value

string|null

at line 223
array getHeaders()

Returns all HTTP headers as associative array.

Return Value

array

at line 232
UrlImmutable|null getReferer()

What URL did the user come from? Beware, it is not reliable at all.

Return Value

UrlImmutable|null

at line 243
bool isSecured()

Is the request sent via secure channel (https)?

Return Value

bool

at line 252
bool isSameSite()

Is the request coming from the same site and is initiated by clicking on a link?

Return Value

bool

at line 261
bool isAjax()

Is it an AJAX request?

Return Value

bool

at line 270
string|null getRemoteAddress()

Returns the IP address of the remote client.

Return Value

string|null

at line 279
string|null getRemoteHost()

Returns the host of the remote client.

Return Value

string|null

at line 291
string|null getRawBody()

Returns raw content of HTTP request body.

Return Value

string|null

at line 301
string|null detectLanguage(array $langs)

Returns the most preferred language by browser. Uses the Accept-Language header. If no match is reached, it returns null.

Parameters

array $langs supported languages

Return Value

string|null

Traits

Strict class for better experience.