Response
extends Message
in package
implements
ISingleton, IResponse
Uses
TSingleton
FinalYes
Tags
Table of Contents
Interfaces
Properties
- $body : string|null
- The body of the message. String if it has been set, null otherwise
- $data : array<string|int, mixed>
- $headers : array<string|int, mixed>
- $http_codes : array<string|int, mixed>
- $instance : ISingleton
- $params : stdClass
- $protocol_version : string
- $reason_phrase : string
- $status_code : int
- $hashCode : int
- $hashCounter : int
Methods
- __call() : mixed
- __callStatic() : mixed
- __destruct() : mixed
- __get() : mixed
- __toString() : string
- extends() : bool
- getBody() : string
- getData() : array<string|int, mixed>|stdClass
- getHeader() : string|null
- Gets a particular header value by a provided header name
- getHeaders() : array<string|int, mixed>
- getInstance() : ISingleton
- getProtocolVersion() : string
- getReasonPhrase() : string
- getReflection() : ReflectionClass
- getStatusCode() : int
- Gets the response status code. The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.
- getStatusLine() : string
- isError() : bool
- setBody() : mixed
- setData() : mixed
- setHeader() : mixed
- Sets an HTTP header within this response.
- setStatusCode() : mixed
- __construct() : mixed
- init() : mixed
- {@inheritdoc}
Properties
$body
The body of the message. String if it has been set, null otherwise
protected
string|null
$body
= ''
$data
protected
array<string|int, mixed>
$data
= array()
$headers
protected
array<string|int, mixed>
$headers
= []
$http_codes
protected
static array<string|int, mixed>
$http_codes
= array(100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-Status', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => 'Switch Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Unordered Collection', 426 => 'Upgrade Required', 449 => 'Retry With', 450 => 'Blocked by Windows Parental Controls', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 509 => 'Bandwidth Limit Exceeded', 510 => 'Not Extended')
Tags
$instance
protected
static ISingleton
$instance
$params
protected
stdClass
$params
$protocol_version
protected
string
$protocol_version
= '1.1'
$reason_phrase
protected
string
$reason_phrase
= ''
$status_code
protected
int
$status_code
= 200
$hashCode
private
int
$hashCode
$hashCounter
private
static int
$hashCounter
= 0
Methods
__call()
public
__call(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : string
- $arguments : array<string|int, mixed>
Tags
__callStatic()
public
static __callStatic(mixed $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : mixed
- $arguments : array<string|int, mixed>
__destruct()
public
__destruct() : mixed
__get()
public
__get(string $property) : mixed
Parameters
- $property : string
__toString()
public
__toString() : string
Tags
Return values
stringextends()
public
extends(ReflectionClass $reflector) : bool
Parameters
- $reflector : ReflectionClass
Return values
boolgetBody()
public
getBody() : string
Return values
stringgetData()
public
getData() : array<string|int, mixed>|stdClass
Return values
array<string|int, mixed>|stdClassgetHeader()
Gets a particular header value by a provided header name
public
getHeader(string $header) : string|null
Parameters
- $header : string
Return values
string|nullgetHeaders()
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>getInstance()
public
static getInstance() : ISingleton
Return values
ISingletongetProtocolVersion()
public
getProtocolVersion() : string
Return values
stringgetReasonPhrase()
public
getReasonPhrase() : string
Return values
stringgetReflection()
public
getReflection() : ReflectionClass
Return values
ReflectionClassgetStatusCode()
Gets the response status code. The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.
public
getStatusCode() : int
Return values
intgetStatusLine()
public
getStatusLine() : string
Tags
Return values
stringisError()
public
isError() : bool
Return values
boolsetBody()
public
setBody(string $body) : mixed
Parameters
- $body : string
setData()
public
setData(array<string|int, mixed>|stdClass $data) : mixed
Parameters
- $data : array<string|int, mixed>|stdClass
setHeader()
Sets an HTTP header within this response.
public
setHeader(string $name, string $value) : mixed
Parameters
- $name : string
- $value : string
Tags
setStatusCode()
public
setStatusCode(int $status_code) : mixed
Parameters
- $status_code : int
__construct()
protected
__construct() : mixed
init()
{@inheritdoc}
protected
init() : mixed