Request
class Request
Executes requets.
Properties
| protected string | $scriptName | Script name. | |
| protected Parameters | $query | Get data. | |
| protected Parameters | $post | Post data. | |
| protected Cookies | $cookies | Cookie data. | |
| protected Files | $files | File data. | |
| protected Server | $server | Server info. | |
| protected Headers | $headers | Request headers. | |
| protected string | $rawBody | Raw request body. | |
| protected Parameters | $parsedBody | Parsed request body. | |
| protected string | $contentType | Content type. | |
| protected array | $trustedProxies | Array of trusted proxy IP addresses. | |
| protected string | $ip | Ip address of the client that made the request. | |
| protected string | $basePath | Base path of the request. | |
| protected string | $baseURL | Base URL of the request. | |
| protected string | $path | Holds the request path. | |
| protected array | $language | Request language. | |
| protected string | $languagePrefix | Request language prefix. | |
| protected string | $method | Which request method was used? | |
| protected string | $realMethod | The actual request method that was used. | |
| protected bool | $isSecure | Was this request made using HTTPS? | |
| protected Route | $route | The route that matched the request. | |
| protected array | $attributes | Request attribuntes. |
Methods
Strips the locale segment from the path.
Determines the request path.
Determines the request method.
Returns the content type of the request body.
Returns the base name of the script that handled the request.
Sets a request attribute.
Gets a request attribute.
Returns the raw request body.
Returns the raw request body as a stream.
Returns the query string.
Returns the post data.
Returns the cookies.
Returns the files.
Returns TRUE if the request has form data and FALSE if not.
Returns the data of the current request method.
Set the trusted proxies.
Is this IP a trusted proxy?
Returns the ip of the client that made the request.
Returns TRUE if the request was made using Ajax and FALSE if not.
Returns TRUE if the request was made using HTTPS and FALSE if not.
Returns TRUE if the request method is considered safe and FALSE if not.
Returns TRUE if the request method is considered idempotent and FALSE if not.
Returns TRUE if the request method is considered cacheable and FALSE if not.
Is PHP running as a CGI program?
Returns the base path of the request.
Returns the base url of the request.
Returns the request path.
Returns TRUE if the resource was requested with a "clean" URL and FALSE if not.
Returns the request language.
Returns the request language prefix.
Returns the request method that was used.
Returns the real request method that was used.
Returns TRUE if the request method has been faked and FALSE if not.
Returns the basic HTTP authentication username or null.
Returns the basic HTTP authentication password or null.
Returns the referrer.
Details
at line 211
__construct(array $request = [], Signer|null $signer = null)
Constructor.
at line 243
protected string
stripLocaleSegment(array $languages, string $path)
Strips the locale segment from the path.
at line 268
protected string
determinePath(array $languages)
Determines the request path.
at line 310
protected string
determineMethod()
Determines the request method.
at line 328
string
getContentType()
Returns the content type of the request body.
An empty string will be returned if the header is missing.
at line 343
string
getScriptName()
Returns the base name of the script that handled the request.
at line 353
setRoute(Route $route)
Set the route that matched the request.
at line 363
Route|null
getRoute()
Returns the route that matched the request.
at line 374
setAttribute(string $name, mixed $value)
Sets a request attribute.
at line 386
mixed
getAttribute(string $name, mixed $default = null)
Gets a request attribute.
at line 396
string
getRawBody()
Returns the raw request body.
at line 411
resource
getRawBodyAsStream()
Returns the raw request body as a stream.
at line 421
Parameters
getQuery()
Returns the query string.
at line 431
Parameters
getPost()
Returns the post data.
at line 441
Cookies
getCookies()
Returns the cookies.
at line 451
Files
getFiles()
Returns the files.
at line 461
Server
getServer()
Returns the files.
at line 471
Headers
getHeaders()
Returns the files.
at line 481
Body
getBody()
Returns the parsed request body.
at line 496
protected bool
hasFormData()
Returns TRUE if the request has form data and FALSE if not.
at line 513
Parameters
getData()
Returns the data of the current request method.
at line 532
setTrustedProxies(array $trustedProxies)
Set the trusted proxies.
at line 543
protected bool
isTrustedProxy(string $ip)
Is this IP a trusted proxy?
at line 561
string
getIp()
Returns the ip of the client that made the request.
at line 600
bool
isAjax()
Returns TRUE if the request was made using Ajax and FALSE if not.
at line 610
bool
isSecure()
Returns TRUE if the request was made using HTTPS and FALSE if not.
at line 630
bool
isSafe()
Returns TRUE if the request method is considered safe and FALSE if not.
at line 640
bool
isIdempotent()
Returns TRUE if the request method is considered idempotent and FALSE if not.
at line 650
bool
isCacheable()
Returns TRUE if the request method is considered cacheable and FALSE if not.
at line 660
bool
isCGI()
Is PHP running as a CGI program?
at line 670
string
getBasePath()
Returns the base path of the request.
at line 687
string
getBaseURL()
Returns the base url of the request.
at line 722
string
getPath()
Returns the request path.
at line 732
bool
isClean()
Returns TRUE if the resource was requested with a "clean" URL and FALSE if not.
at line 742
array|null
getLanguage()
Returns the request language.
at line 752
string|null
getLanguagePrefix()
Returns the request language prefix.
at line 762
string
getMethod()
Returns the request method that was used.
at line 772
string
getRealMethod()
Returns the real request method that was used.
at line 782
bool
isFaked()
Returns TRUE if the request method has been faked and FALSE if not.
at line 792
string|null
getUsername()
Returns the basic HTTP authentication username or null.
at line 802
string|null
getPassword()
Returns the basic HTTP authentication password or null.
at line 813
mixed
getReferrer(mixed $default = null)
Returns the referrer.