Класс HttpSocketResponse

HTTP-ответ от HttpSocket.

HttpSocketResponse реализует ArrayAccess

Непосредственные подклассы

HttpResponse

Пакет: Cake\Network\Http
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Network/Http/HttpSocketResponse.php

Краткое описание свойств

$body public

string
Содержимое тела
$code public

integer
Код ответа
$context public

array

Данные контекста в ответе. Например, содержит сертификаты SSL.
$cookies public

array
Куки
$headers public

array
Заголовки
$httpVersion public

string
Версия HTTP
$raw public

string
Чистое исходное содержимое
$reasonPhrase public

string
Фраза причины

Краткое описание методов

__construct() public
Конструктор
__toString() public
Представление объекта в виде строки
_decodeBody() protected

Универсальная функция для декодирования $body с заданным $encoding. Возвращает массив с ключами 'body' и 'header' или false при ошибке.
_decodeChunkedBody() protected

Декодирует фрагментированное сообщение $body и возвращает массив с ключами 'body' и 'header' или false в качестве результата.
_parseHeader() protected
Парсит заголовок на основе массива.
_tokenEscapeChars() protected
Получает символы экранирования в соответствии со спецификацией RFC 2616 (HTTP 1.1).
_unescapeToken() protected
Деэкранирует заданный $token в соответствии со спецификацией RFC 2616 (HTTP 1.1).
body() public
Содержимое тела
getHeader() public
Получение заголовка без учета регистра
isOk() public
Если возвращается 200 (OK)
isRedirect() public
Если возвращается значение 3xx (перенаправление)
offsetExists() public
ArrayAccess - Существование смещения
offsetGet() public
ArrayAccess - Получение смещения
offsetSet() public
ArrayAccess - Установка смещения
offsetUnset() public
ArrayAccess - Удаление смещения
parseCookies() public
Парсит куки в заголовках ответа.
parseResponse() public
Парсит заданное сообщение и разделяет его на части.

Подробное описание методов

__construct()source public

__construct( string $message null )

Конструктор

Параметры

string $message необязательно null: Сообщение для парсинга.

__toString()source public

__toString( )

Представление объекта в виде строки

Возвращает

string

_decodeBody()source protected

_decodeBody( string $body , string|boolean $encoding 'chunked' )

Универсальная функция для декодирования $body с заданным $encoding. Возвращает массив с ключами 'body' и 'header' или false при ошибке.

Параметры

string $body: Строка, содержащая тело для декодирования.
string|boolean $encoding необязательно 'chunked': Может быть false, если кодирование не используется, или строкой, представляющей кодирование.

Возвращает

mixed
Массив заголовков и тела ответа или false.

_decodeChunkedBody()source protected

_decodeChunkedBody( string $body )

Декодирует фрагментированное сообщение $body и возвращает массив с ключами 'body' и 'header' или false в качестве результата.

Параметры

string $body: Строка, содержащая фрагментированное тело для декодирования.

Возвращает

mixed
Массив заголовков и тела ответа или false.

Исключения

SocketException

_parseHeader()source protected

_parseHeader( array $header )

Парсит заголовок на основе массива.

Параметры

array $header: Заголовок в виде индексированного массива (поле => значение)

Возвращает

array
Парсинг заголовка

_tokenEscapeChars()source protected

_tokenEscapeChars( boolean $hex true , array $chars null )

Получает символы экранирования в соответствии со спецификацией RFC 2616 (HTTP 1.1).

Параметры

boolean $hex необязательно true: True, чтобы получить их как значения HEX, в противном случае false.
array $chars необязательно null: Символы для деэкранирования.

Возвращает

array
Символы экранирования

_unescapeToken()source protected

_unescapeToken( string $token , array $chars null )

Деэкранирует заданный $token в соответствии со спецификацией RFC 2616 (HTTP 1.1).

Параметры

string $token: Токен для деэкранирования.
array $chars необязательно null: Символы для деэкранирования.

Возвращает

string
Деэкранированный токен

body()source public

body( )

Содержимое тела

Возвращает

string

getHeader()source public

getHeader( string $name , array $headers null )

Получение заголовка без учета регистра

Параметры

string $name: Имя заголовка.
array $headers необязательно null: Заголовки для форматирования.

Возвращает

mixed
Строка, если заголовок существует, или null

isOk()source public

isOk( )

Если возвращается 200 (OK)

Возвращает

boolean

END_OF_DOCUMENT_MARKER

isRedirect()source public

isRedirect( )

Если возвращаемое значение — это допустимый код 3xx (перенаправление)

Возвращает

boolean

offsetExists()source public

offsetExists( string $offset )

ArrayAccess — Существование смещения

Параметры

string $offset: Смещение для проверки.

Возвращает

boolean

Реализация

ArrayAccess::offsetExists()

offsetGet()source public

offsetGet( string $offset )

ArrayAccess — Получение смещения

Параметры

string $offset: Смещение для получения.

Возвращает

mixed

Реализация

ArrayAccess::offsetGet()

offsetSet()source public

offsetSet( string $offset , mixed $value )

ArrayAccess — Установка смещения

Параметры

string $offset: Смещение для установки.
mixed $value: Значение.

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public

offsetUnset( string $offset )

ArrayAccess — Удаление смещения

Параметры

string $offset: Смещение для удаления.

Реализация

ArrayAccess::offsetUnset()

parseCookies()source public

parseCookies( array $header )

Парсит куки в заголовках ответа.

Параметры

array $header: Массив заголовков, содержащий один или несколько заголовков 'Set-Cookie'.

Возвращает

mixed
Либо false при отсутствии куки, либо массив полученных куки.

parseResponse()source public

parseResponse( string $message )

Парсит данное сообщение и разбивает его на части.

Параметры

string $message: Сообщение для парсинга

Исключения

SocketException

Подробное описание свойств

$bodysource

public string

Содержимое тела

''

$codesource

public integer

Код ответа

$contextsource

public array

Данные контекста в ответе. Например, сертификаты SSL.

array()

$cookiessource

public array

Куки

array()

$headerssource

public array

Заголовки

array()

$httpVersionsource

public string

Версия HTTP

'HTTP/1.1'

$rawsource

public string

Чистое исходное содержимое

''

$reasonPhrasesource

public string

Фраза причины

''

© 2005–2016 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.
http://api.cakephp.org/2.8/class-HttpSocketResponse.html