Class HttpSocketResponse
HTTP Response from HttpSocket.
- HttpSocketResponse implements ArrayAccess
Direct Subclasses
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Network/Http/HttpSocketResponse.php
Properties summary
-
$bodypublicstringBody content -
$codepublicintegerResponse code -
$contextpublicarrayContext data in the response. Contains SSL certificates for example.
-
$cookiespublicarrayCookies -
$headerspublicarrayHeaders -
$httpVersionpublicstringHTTP version -
$rawpublicstringPure raw content -
$reasonPhrasepublicstringReason phrase
Method Summary
-
__construct() public
Constructor -
__toString() public
Instance as string -
_decodeBody() protected
Generic function to decode a $body with a given $encoding. Returns either an array with the keys 'body' and 'header' or false on failure.
-
_decodeChunkedBody() protected
Decodes a chunked message $body and returns either an array with the keys 'body' and 'header' or false as a result.
-
_parseHeader() protected
Parses an array based header. -
_tokenEscapeChars() protected
Gets escape chars according to RFC 2616 (HTTP 1.1 specs). -
_unescapeToken() protected
Unescapes a given $token according to RFC 2616 (HTTP 1.1 specs) -
body() public
Body content -
getHeader() public
Get header in case insensitive -
isOk() public
If return is 200 (OK) -
isRedirect() public
If return is a valid 3xx (Redirection) -
offsetExists() public
ArrayAccess - Offset Exists -
offsetGet() public
ArrayAccess - Offset Get -
offsetSet() public
ArrayAccess - Offset Set -
offsetUnset() public
ArrayAccess - Offset Unset -
parseCookies() public
Parses cookies in response headers. -
parseResponse() public
Parses the given message and breaks it down in parts.
Method Detail
__construct() public ¶
__construct( string $message = null )
Constructor
Parameters
- string $message optional null
- Message to parse.
_decodeBody() protected ¶
_decodeBody( string $body , string|boolean $encoding = 'chunked' )
Generic function to decode a $body with a given $encoding. Returns either an array with the keys 'body' and 'header' or false on failure.
Parameters
- string $body
- A string containing the body to decode.
- string|boolean $encoding optional 'chunked'
- Can be false in case no encoding is being used, or a string representing the encoding.
Returns
Array of response headers and body or false.
_decodeChunkedBody() protected ¶
_decodeChunkedBody( string $body )
Decodes a chunked message $body and returns either an array with the keys 'body' and 'header' or false as a result.
Parameters
- string $body
- A string containing the chunked body to decode.
Returns
Array of response headers and body or false.
Throws
_parseHeader() protected ¶
_parseHeader( array $header )
Parses an array based header.
Parameters
- array $header
- Header as an indexed array (field => value)
Returns
Parsed header
_tokenEscapeChars() protected ¶
_tokenEscapeChars( boolean $hex = true , array $chars = null )
Gets escape chars according to RFC 2616 (HTTP 1.1 specs).
Parameters
- boolean $hex optional true
- True to get them as HEX values, false otherwise.
- array $chars optional null
- Characters to uescape.
Returns
Escape chars
_unescapeToken() protected ¶
_unescapeToken( string $token , array $chars = null )
Unescapes a given $token according to RFC 2616 (HTTP 1.1 specs)
Parameters
- string $token
- Token to unescape.
- array $chars optional null
- Characters to unescape.
Returns
Unescaped token
getHeader() public ¶
getHeader( string $name , array $headers = null )
Get header in case insensitive
Parameters
- string $name
- Header name.
- array $headers optional null
- Headers to format.
Returns
String if header exists or null
offsetExists() public ¶
offsetExists( string $offset )
ArrayAccess - Offset Exists
Parameters
- string $offset
- Offset to check.
Returns
Implementation of
ArrayAccess::offsetExists()offsetGet() public ¶
offsetGet( string $offset )
ArrayAccess - Offset Get
Parameters
- string $offset
- Offset to get.
Returns
Implementation of
ArrayAccess::offsetGet()offsetSet() public ¶
offsetSet( string $offset , mixed $value )
ArrayAccess - Offset Set
Parameters
- string $offset
- Offset to set.
- mixed $value
- Value.
Implementation of
ArrayAccess::offsetSet()offsetUnset() public ¶
offsetUnset( string $offset )
ArrayAccess - Offset Unset
Parameters
- string $offset
- Offset to unset.
Implementation of
ArrayAccess::offsetUnset()parseCookies() public ¶
parseCookies( array $header )
Parses cookies in response headers.
Parameters
- array $header
- Header array containing one ore more 'Set-Cookie' headers.
Returns
Either false on no cookies, or an array of cookies received.
parseResponse() public ¶
parseResponse( string $message )
Parses the given message and breaks it down in parts.
Parameters
- string $message
- Message to parse