Request
Table of Contents
- $_body : mixed
- $_method : mixed
- $_options : mixed
- $_path : mixed
- __construct() : mixed
- Constructor
- getBody() : array<string|int, mixed>
- Returns the request body
- getBodyAsJson() : array<string|int, mixed>
- Returns the JSON body included in the request
- getCustomHeaders() : array<string|int, mixed>
- Returns the user supplied request headers Note: These may be overridden by core library headers. The full list of headers can be obtained with getHeaders()
- getHeaders() : array<string|int, mixed>
- Returns the request headers.
- getMethod() : string
- Returns the HTTP method that was used
- getOptions() : array<string|int, mixed>
- Returns the request options
- getParams() : array<string|int, mixed>
- Returns the request query string parameters
- getPath() : string
- Returns the path that the HTTP request was made to
Properties
$_body
private
mixed
$_body
$_method
private
mixed
$_method
$_options
private
mixed
$_options
$_path
private
mixed
$_path
Methods
__construct()
Constructor
public
__construct(string $method, string $path, array<string|int, mixed> $body, array<string|int, mixed> $options) : mixed
Parameters
- $method : string
-
HTTP method to use
- $path : string
-
Tokenized path to request
- $body : array<string|int, mixed>
-
The request body
- $options : array<string|int, mixed>
-
Additional request parameters (including query parameters)
Return values
mixed —getBody()
Returns the request body
public
getBody() : array<string|int, mixed>
Return values
array<string|int, mixed> —The request body
getBodyAsJson()
Returns the JSON body included in the request
public
getBodyAsJson() : array<string|int, mixed>
Return values
array<string|int, mixed> —The request body
getCustomHeaders()
Returns the user supplied request headers Note: These may be overridden by core library headers. The full list of headers can be obtained with getHeaders()
public
getCustomHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —The custom request headers
getHeaders()
Returns the request headers.
public
getHeaders() : array<string|int, mixed>
Note: The Content-Length header is not included here as it is calculated just prior to the request being sent.
Return values
array<string|int, mixed> —Associative array of headers
getMethod()
Returns the HTTP method that was used
public
getMethod() : string
Return values
string —The HTTP method
getOptions()
Returns the request options
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —The options included in the request
getParams()
Returns the request query string parameters
public
getParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —The query string parameters
getPath()
Returns the path that the HTTP request was made to
public
getPath() : string
Return values
string —The path