Request
class Request
Executes requets.
Constants
| REMOTE_ADDRESS_FALLBACK |
Remote address fallback. |
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 Body | $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 216
__construct(array $request = [], Signer|null $signer = null)
Constructor.
at line 248
protected string
stripLocaleSegment(array $languages, string $path)
Strips the locale segment from the path.
at line 273
protected string
determinePath(array $languages)
Determines the request path.
at line 315
protected string
determineMethod()
Determines the request method.
at line 333
string
getContentType()
Returns the content type of the request body.
An empty string will be returned if the header is missing.
at line 348
string
getScriptName()
Returns the base name of the script that handled the request.
at line 358
setRoute(Route $route)
Set the route that matched the request.
at line 368
Route|null
getRoute()
Returns the route that matched the request.
at line 379
setAttribute(string $name, mixed $value)
Sets a request attribute.
at line 391
mixed
getAttribute(string $name, mixed $default = null)
Gets a request attribute.
at line 401
string
getRawBody()
Returns the raw request body.
at line 416
resource
getRawBodyAsStream()
Returns the raw request body as a stream.
at line 426
Parameters
getQuery()
Returns the query string.
at line 436
Parameters
getPost()
Returns the post data.
at line 446
Cookies
getCookies()
Returns the cookies.
at line 456
Files
getFiles()
Returns the files.
at line 466
Server
getServer()
Returns the files.
at line 476
Headers
getHeaders()
Returns the files.
at line 486
Body
getBody()
Returns the parsed request body.
at line 501
protected bool
hasFormData()
Returns TRUE if the request has form data and FALSE if not.
at line 518
Parameters
getData()
Returns the data of the current request method.
at line 537
setTrustedProxies(array $trustedProxies)
Set the trusted proxies.
at line 548
protected bool
isTrustedProxy(string $ip)
Is this IP a trusted proxy?
at line 566
string
getIp()
Returns the ip of the client that made the request.
at line 605
bool
isAjax()
Returns TRUE if the request was made using Ajax and FALSE if not.
at line 615
bool
isSecure()
Returns TRUE if the request was made using HTTPS and FALSE if not.
at line 635
bool
isSafe()
Returns TRUE if the request method is considered safe and FALSE if not.
at line 645
bool
isIdempotent()
Returns TRUE if the request method is considered idempotent and FALSE if not.
at line 655
bool
isCacheable()
Returns TRUE if the request method is considered cacheable and FALSE if not.
at line 665
bool
isCGI()
Is PHP running as a CGI program?
at line 675
string
getBasePath()
Returns the base path of the request.
at line 692
string
getBaseURL()
Returns the base url of the request.
at line 727
string
getPath()
Returns the request path.
at line 737
bool
isClean()
Returns TRUE if the resource was requested with a "clean" URL and FALSE if not.
at line 747
array|null
getLanguage()
Returns the request language.
at line 757
string|null
getLanguagePrefix()
Returns the request language prefix.
at line 767
string
getMethod()
Returns the request method that was used.
at line 777
string
getRealMethod()
Returns the real request method that was used.
at line 787
bool
isFaked()
Returns TRUE if the request method has been faked and FALSE if not.
at line 797
string|null
getUsername()
Returns the basic HTTP authentication username or null.
at line 807
string|null
getPassword()
Returns the basic HTTP authentication password or null.
at line 818
mixed
getReferrer(mixed $default = null)
Returns the referrer.