Class HttpSocketResponse

HTTP Response from HttpSocket.

HttpSocketResponse implements ArrayAccess

Direct Subclasses

Package: Cake\Network\Http
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Network/Http/HttpSocketResponse.php

Properties summary

  • $body public
    string
    Body content
  • $code public
    integer
    Response code
  • $context public
    array

    Context data in the response. Contains SSL certificates for example.

  • $cookies public
    array
    Cookies
  • $headers public
    array
    Headers
  • $httpVersion public
    string
    HTTP version
  • $raw public
    string
    Pure raw content
  • $reasonPhrase public
    string
    Reason 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.

  • 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.
  • 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)
  • ArrayAccess - Offset Exists
  • offsetGet() public
    ArrayAccess - Offset Get
  • offsetSet() public
    ArrayAccess - Offset Set
  • offsetUnset() public
    ArrayAccess - Offset Unset
  • Parses cookies in response headers.
  • Parses the given message and breaks it down in parts.

Method Detail

__construct()source public 

__construct( string $message null )

Constructor

Parameters

string $message optional null
Message to parse.

__toString()source public 

__toString( )

Instance as string

Returns

string

_decodeBody()source 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

mixed
Array of response headers and body or false.

_decodeChunkedBody()source 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

mixed
Array of response headers and body or false.

Throws

SocketException

_parseHeader()source protected 

_parseHeader( array $header )

Parses an array based header.

Parameters

array $header
Header as an indexed array (field => value)

Returns

array
Parsed header

_tokenEscapeChars()source 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

array
Escape chars

_unescapeToken()source 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

string
Unescaped token

body()source public 

body( )

Body content

Returns

string

getHeader()source 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

mixed
String if header exists or null

isOk()source public 

isOk( )

If return is 200 (OK)

Returns

boolean

isRedirect()source public 

isRedirect( )

If return is a valid 3xx (Redirection)

Returns

boolean

offsetExists()source public 

offsetExists( string $offset )

ArrayAccess - Offset Exists

Parameters

string $offset
Offset to check.

Returns

boolean

Implementation of

ArrayAccess::offsetExists()

offsetGet()source public 

offsetGet( string $offset )

ArrayAccess - Offset Get

Parameters

string $offset
Offset to get.

Returns

mixed

Implementation of

ArrayAccess::offsetGet()

offsetSet()source public 

offsetSet( string $offset , mixed $value )

ArrayAccess - Offset Set

Parameters

string $offset
Offset to set.
mixed $value
Value.

Implementation of

ArrayAccess::offsetSet()

offsetUnset()source public 

offsetUnset( string $offset )

ArrayAccess - Offset Unset

Parameters

string $offset
Offset to unset.

Implementation of

ArrayAccess::offsetUnset()

parseCookies()source public 

parseCookies( array $header )

Parses cookies in response headers.

Parameters

array $header
Header array containing one ore more 'Set-Cookie' headers.

Returns

mixed
Either false on no cookies, or an array of cookies received.

parseResponse()source public 

parseResponse( string $message )

Parses the given message and breaks it down in parts.

Parameters

string $message
Message to parse

Throws

SocketException

Properties detail

$bodysource

public string

Body content

''

$codesource

public integer

Response code

$contextsource

public array

Context data in the response. Contains SSL certificates for example.

array()

$cookiessource

public array

Cookies

array()

$headerssource

public array

Headers

array()

$httpVersionsource

public string

HTTP version

'HTTP/1.1'

$rawsource

public string

Pure raw content

''

$reasonPhrasesource

public string

Reason phrase

''

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-HttpSocketResponse.html