AbstractRequest
in package
AbstractYes
An HTTP Request.
Table of Contents
Properties
- $headers : mixed
- $messageBody : mixed
- $method : mixed
- $urlVariables : mixed
Methods
- __set() : mixed
- The magic setter is overridden to insure immutability.
- getHeaders() : array<string|int, mixed>
- getMessageBody() : AbstractMessageBody
- getMethod() : string
- getUrlVariables() : array<string|int, mixed>
- __construct() : mixed
Properties
$headers
protected
mixed
$headers
$messageBody
protected
mixed
$messageBody
$method
protected
mixed
$method
$urlVariables
protected
mixed
$urlVariables
Methods
__set()
The magic setter is overridden to insure immutability.
public
final __set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
getHeaders()
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —The optional headers
getMessageBody()
public
getMessageBody() : AbstractMessageBody
Return values
AbstractMessageBody —the message body to be sent with the request
getMethod()
public
getMethod() : string
Return values
string —GET, POST, PUT, PATCH or DELETE
getUrlVariables()
public
getUrlVariables() : array<string|int, mixed>
Return values
array<string|int, mixed> —the value of the URL variables contained in the URL template
__construct()
protected
__construct([string $method = 'GET' ][, array<string|int, mixed>|null $urlVariables = null ][, AbstractMessageBody|null $messageBody = null ][, array<string|int, mixed>|null $headers = null ]) : mixed
Parameters
- $method : string = 'GET'
-
GET, POST, PUT, PATCH or DELETE
- $urlVariables : array<string|int, mixed>|null = null
-
The value of the URL variables contained in the URL template
- $messageBody : AbstractMessageBody|null = null
-
The messageBody to send with the request
- $headers : array<string|int, mixed>|null = null
-
Optional headers