Класс HttpSocketResponse

HTTP-ответ от HttpSocket.

HttpSocketResponse реализует ArrayAccess

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

HttpResponse

Пакет: Cake\Network\Http
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://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 )

Конструктор

Параметры

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

__toString()source public

__toString( )

Объект как строка

Возвращает

строка

_decodeBody()source protected

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

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

Параметры

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

Возвращает

смешанный тип
Массив заголовков и тела ответа или false.

_decodeChunkedBody()source protected

_decodeChunkedBody( string $body )

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

Параметры

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

Возвращает

смешанный тип
Массив заголовков и тела ответа или false.

Исключения

SocketException

_parseHeader()source protected

_parseHeader( array $header )

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

Параметры

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

Возвращает

массив
Обработанный заголовок

_tokenEscapeChars()source protected

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

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

Параметры

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

Возвращает

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

_unescapeToken()source protected

_unescapeToken( string $token , array $chars null )

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

Параметры

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

Возвращает

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

body()source public

body( )

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

Возвращает

строка

getHeader()source public

getHeader( string $name , array $headers null )

Получить заголовок, нечувствительный к регистру

Параметры

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

Возвращает

смешанный тип
Строка, если заголовок существует, или null

isOk()source public

isOk( )

Если возвращаемое значение равно 200 (OK)

Возвращает

булево

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
Ложь, если нет куки, или массив полученных куки.

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–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