Класс Response

Реализует методы для HTTP-ответов.

Все следующие примеры предполагают, что $response является экземпляром этого класса.

Получение значений заголовков

Имена заголовков нечувствительны к регистру, но нормализуются в верхнем регистре с прописной первой буквой при разборе ответа.

$val = $response->header('content-type');

Прочитает заголовок Content-Type. Вы можете получить все установленные заголовки, используя:

$response->header();

Вы также можете получить доступ к заголовкам с помощью доступа по объекту. При получении заголовков с помощью доступа по объекту необходимо использовать имена заголовков, чувствительные к регистру:

$val = $response->headers['Content-Type'];

Получение тела ответа

Вы можете получить доступ к телу ответа, используя:

$content = $response->body();

Вы также можете использовать доступ по объекту:

$content = $response->body;

Если тело вашего ответа находится в формате XML или JSON, вы можете использовать специальные методы доступа, специфичные для типа содержимого, для чтения декодированных данных. Данные JSON будут возвращены в виде массивов, а данные XML — в виде узлов SimpleXML:

// Get as xml
$content = $response->xml
// Get as json
$content = $response->json

Если ответ нельзя декодировать, будет возвращено значение null.

Проверка кода состояния

Вы можете получить доступ к коду состояния ответа, используя:

$content = $response->statusCode();

Вы также можете использовать доступ по объекту:

$content = $response->code;

Cake\Network\Http\Message

Cake\Network\Http\Response

Пространство имён: Cake\Network\Http
Расположение: Network/Http/Response.php

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

__constructsource public

__construct( array $headers [] , string $body '' )

Конструктор

Параметры

массив $headers необязательно []: Необработанные заголовки.
строка $body необязательно '': Тело ответа.

__getsource public

__get( string $name )

Чтение значений как свойств.

Параметры

строка $name: Имя свойства.

Возвращает

mixed
смешанный тип

__issetsource public

__isset( string $name )

Тест isset/empty с использованием синтаксиса ->.

Параметры

строка $name: Имя свойства.

Возвращает

boolean
логическое значение

_decodeGzipBodysource protected

_decodeGzipBody( string $body )

Распаковка gzip ответа.

Ищет сигнатуры gzip, и если gzinflate() существует, тело будет распаковано.

Параметры

строка $body: Тело, закодированное в gzip.

Возвращает

string
строка

Исключения

RuntimeException
При попытке декодирования gzip-содержимого без gzinflate.

_getJsonsource protected

_getJson( )

Получить тело ответа как декодированные данные JSON.

Возвращает

null|array
null|массив

_getXmlsource protected

_getXml( )

Получить тело ответа как декодированные данные XML.

Возвращает

null|SimpleXMLElement
null|\SimpleXMLElement

_parseCookiesource protected

_parseCookie( string $value )

Разбор заголовка cookie в данные.

Параметры

строка $value: Значение cookie для разбора.

_parseHeaderssource protected

_parseHeaders( array $headers )

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

Декодирует код состояния.
Парсит и нормализует имена и значения заголовков.

Параметры

массив $headers: Заголовки для парсинга.

bodysource public

body( callable|null $parser null )

Получить тело ответа.

Передав вызываемую функцию $parser, вы можете получить декодированное содержимое ответа обратно.

Например, чтобы получить данные json как объект:

$body = $response->body('json_decode');

Параметры

вызываемая функция|null $parser необязательно null: Обработчик для декодирования тела ответа.

Возвращает

mixed
Тело ответа.

Переопределяет

Cake\Network\Http\Message::body()

cookiesource public

cookie( string|null $name null , boolean $all false )

Чтение одного/нескольких значений cookie.

Параметры

строка|null $name необязательно null: Имя cookie, которое вы хотите. Оставьте null, чтобы получить все cookie.
логическое значение $all необязательно false: Получить все части cookie. Если false, возвращается только значение.

Возвращает

mixed
смешанный тип

encodingsource public

encoding( )

Получить кодировку, если она была установлена.

Возвращает

string|null
строка|null

headersource public

header( string|null $name null )

Чтение одного/нескольких значений заголовка.

Параметры

строка|null $name необязательно null: Имя заголовка, которое вы хотите. Оставьте null, чтобы получить все заголовки.

Возвращает

mixed
Null, если заголовок не существует. Массив будет возвращён при получении всех заголовков или при получении заголовка, у которого было установлено несколько значений. В противном случае возвращается строка.

isOksource public

isOk( )

Проверка, был ли ответ OK

Возвращает

boolean
логическое значение

isRedirectsource public

isRedirect( )

Проверка, был ли ответ перенаправлением.

Возвращает

boolean
логическое значение

statusCodesource public

statusCode( )

Получить код состояния из ответа

Возвращает

integer
целое число

Наследованные методы из Cake\Network\Http\Message

_normalizeHeadersource protected

_normalizeHeader( string $name )

Нормализация имён заголовков в формате CamelCase.

Параметры

строка $name: Имя заголовка для нормализации.

Возвращает

string
Нормализованное имя заголовка.

cookiessource public

cookies( )

Получить все cookie

Возвращает

array
массив

headerssource public

headers( )

Получить все заголовки

Возвращает

array
массив

END_OF_DOCUMENT_MARKER ```

versionsource public

version( )

Получить используемую версию HTTP.

Возвращает

string
строка

Постоянные значения, унаследованные от Cake\Network\Http\Message

METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_OPTIONS, METHOD_PATCH, METHOD_POST, METHOD_PUT, METHOD_TRACE, STATUS_ACCEPTED, STATUS_CREATED, STATUS_FOUND, STATUS_MOVED_PERMANENTLY, STATUS_OK, STATUS_SEE_OTHER, STATUS_TEMPORARY_REDIRECT

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

$_bodysource

protected строка

Тело ответа

$_codesource

protected целое число

Код состояния ответа.

$_exposedPropertiessource

protected массив

Карта имен свойств public => property для __get()

[
    'cookies' => '_cookies',
    'headers' => '_headers',
    'body' => '_body',
    'code' => '_code',
    'json' => '_getJson',
    'xml' => '_getXml'
]

$_jsonsource

protected массив

Кэшированные декодированные данные JSON.

$_xmlsource

protected SimpleXMLElement

Кэшированные декодированные данные XML.

Краткое описание унаследованных свойств от Cake\Network\Http\Message

$_cookiessource

protected массив

Массив куки в ответе.

[]

$_headerssource

protected массив

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

[]

$_versionsource

protected строка

Используемая версия HTTP.

'1.1'

© 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/3.1/class-Cake.Network.Http.Response.html