Request
extends Request
in package
HTTP Request class
Tags
Table of Contents
- getPost() : ParametersInterface|mixed
- Return the parameter container responsible for post parameters or a single post parameter.
- getQuery() : ParametersInterface|mixed
- Return the parameter container responsible for query parameters or a single query parameter
- getServer() : ParametersInterface|mixed
- Return the parameter container responsible for server parameters or a single parameter value.
- cleanup() : ParametersInterface|mixed
- Clean up a parameter
- isValid() : bool
- Check if a parameter is valid
Methods
getPost()
Return the parameter container responsible for post parameters or a single post parameter.
public
getPost([string|null $name = null ][, mixed|null $default = null ]) : ParametersInterface|mixed
Parameters
- $name : string|null = null
-
Parameter name to retrieve, or null to get the whole container.
- $default : mixed|null = null
-
Default value to use when the parameter is missing.
Return values
ParametersInterface|mixed —getQuery()
Return the parameter container responsible for query parameters or a single query parameter
public
getQuery([string|null $name = null ][, mixed|null $default = null ]) : ParametersInterface|mixed
Parameters
- $name : string|null = null
-
Parameter name to retrieve, or null to get the whole container.
- $default : mixed|null = null
-
Default value to use when the parameter is missing.
Return values
ParametersInterface|mixed —getServer()
Return the parameter container responsible for server parameters or a single parameter value.
public
getServer([string|null $name = null ][, mixed|null $default = null ]) : ParametersInterface|mixed
Parameters
- $name : string|null = null
-
Parameter name to retrieve, or null to get the whole container.
- $default : mixed|null = null
-
Default value to use when the parameter is missing.
Tags
Return values
ParametersInterface|mixed —cleanup()
Clean up a parameter
protected
cleanup(ParametersInterface|mixed $param) : ParametersInterface|mixed
Parameters
- $param : ParametersInterface|mixed
-
Parameter
Return values
ParametersInterface|mixed —isValid()
Check if a parameter is valid
protected
isValid(mixed $param) : bool
Parameters
- $param : mixed
-
Parameter to check