Spec-Zone.ru › CakePHP 3.8

Класс Response

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

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

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

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

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

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

$response->getHeaders();

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

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

$content = $response->getBody();

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

$content = $response->getStringBody();

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

// Get as xml
$content = $response->getXml()
// Get as json
$content = $response->getJson()

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

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

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

$content = $response->getStatusCode();
Cake\Http\Client\Message
Расширенный Cake\Http\Client\Response реализует Psr\Http\Message\ResponseInterface использует Zend\Diactoros\MessageTrait
Пространство имен: Cake\Http\Client
Расположение: Http/Client/Response.php

Наследуемые константы

  • 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_NON_AUTHORITATIVE_INFORMATION, STATUS_NO_CONTENT, STATUS_OK, STATUS_SEE_OTHER, STATUS_TEMPORARY_REDIRECT

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

  • $_exposedProperties protected
    array
    Карта public => имена свойств для __get()
  • $_json protected
    array
    Кэшированные декодированные данные JSON.
  • $_xml protected
    SimpleXMLElement
    Кэшированные декодированные данные XML.
  • $code protected
    integer
    Код состояния ответа.
  • $cookies protected
    Cake\Http\Cookie\CookieCollection
    Экземпляр коллекции куки
  • $reasonPhrase protected
    string
    Фраза причины для кода состояния

Наследуемые магические свойства

  • headers

Наследуемые свойства

  • _body, _cookies

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

  • __construct() public
    Конструктор
  • __get() public
    Чтение значений как свойств.
  • __isset() public
    Тест isset/empty с синтаксисом ->.
  • _decodeGzipBody() protected
    Распаковка ответа gzip.
  • _getBody() protected
    Обеспечивает поддержку магического __get().
  • _getCookies() protected
    Доступ к свойству $this->cookies
  • _getHeaders() protected
    Обеспечивает поддержку магического __get().
  • _getJson() protected
    Получение тела ответа в виде декодированных данных JSON.
  • _getXml() protected
    Получение тела ответа в виде декодированных данных XML.
  • _parseHeaders() protected
    Разбор заголовков при необходимости.
  • body() public устаревший
    Получить тело ответа.
  • buildCookieCollection() protected
    Лениво создает CookieCollection и cookie-объекты из заголовка ответа
  • convertCookieToArray() protected
    Преобразование cookie в массив его свойств.
  • cookie() public устаревший
    Чтение одного/нескольких значений cookie.
  • encoding() public устаревший
    Получить кодировку, если она была установлена.
  • getCookie() public
    Получить значение одного cookie.
  • getCookieCollection() public
    Получить коллекцию cookie из этого ответа.
  • getCookieData() public
    Получить полные данные для одного cookie.
  • getCookies() public
    Получить все данные о cookie.
  • getEncoding() public
    Получить кодировку, если она была установлена.
  • getJson() public
    Получить тело ответа в виде декодированных данных JSON.
  • getReasonPhrase() public
  • getStatusCode() public
  • getStringBody() public
    Получить тело ответа в виде строки.
  • getXml() public
    Получить тело ответа в виде декодированных данных XML.
  • header() public устаревший
    Чтение одного/нескольких значений заголовка.
  • isOk() public
    Проверка, был ли ответ OK
  • isRedirect() public
    Проверка, был ли код состояния переадресации.
  • statusCode() public устаревший
    Получение кода состояния из ответа
  • version() public устаревший
    Получение используемой версии HTTP.
  • withStatus() public

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

__construct()source public 

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

Конструктор

Параметры

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

__get()source public 

__get( string $name )

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

Параметры

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

Возвращает

смешанный

__isset()source public 

__isset( string $name )

Тест isset/empty с синтаксисом ->.

Параметры

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

Возвращает

булево

_decodeGzipBody()source protected 

_decodeGzipBody( string $body )

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

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

Параметры

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

Возвращает

строка

Исключения

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

_getBody()source protected 

_getBody( )

Обеспечивает поддержку магического метода __get().

Возвращает

string

_getCookies()source protected 

_getCookies( )

Доступ к свойству $this->cookies

Возвращает

array
Массив данных куки.

_getHeaders()source protected 

_getHeaders( )

Обеспечивает поддержку магического метода __get().

Возвращает

array

_getJson()source protected 

_getJson( )

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

Возвращает

array|null

_getXml()source protected 

_getXml( )

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

Возвращает

null|SimpleXMLElement

_parseHeaders()source protected 

_parseHeaders( array $headers )

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

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

Параметры

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

body()source public deprecated 

body( callable|null $parser = null )

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

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

Например, для получения JSON-данных в виде объекта:

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

Устарело

3.7.0 Используйте getStringBody()/getJson()/getXml() вместо этого.

Параметры

callable|null $parser optional null

Функция обратного вызова для декодирования тела ответа.

Возвращает

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

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

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

buildCookieCollection()source protected 

buildCookieCollection( )

Ленивое создание CookieCollection и объектов куки из заголовка ответа

convertCookieToArray()source protected 

convertCookieToArray( Cake\Http\Cookie\CookieInterface $cookie )

Преобразование куки в массив его свойств.

Этот метод совместим со старым клиентским кодом, который ожидает строки дат вместо отметки времени.

Параметры

Cake\Http\Cookie\CookieInterface $cookie
Объект куки.

Возвращает

array

cookie()source public deprecated 

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

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

Примечание Этот метод предоставляет доступ только к кукам, добавленным в конструкторе. Если куки добавляются после создания, они недоступны через этот метод.

Устарело

3.3.0 Используйте getCookie(), getCookieData() или getCookies() вместо этого.

Параметры

string|null $name optional null

Имя куки, которую вы хотите получить. Оставьте null, чтобы получить все куки.

boolean $all optional false

Получить все части куки. Когда false, возвращается только значение.

Возвращает

mixed

encoding()source public deprecated 

encoding( )

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

Устарело

3.3.0 Используйте getEncoding() вместо этого.

Возвращает

string|null

getCookie()source public 

getCookie( string $name )

Получение значения одной куки.

Параметры

string $name
Имя значения куки.

Возвращает

string|array|null
Значение куки или null, если куки не определена.

getCookieCollection()source public 

getCookieCollection( )

Получение коллекции куки из этого ответа.

Этот метод предоставляет доступ к экземпляру CookieCollection ответа, позволяя взаимодействовать с объектами куки напрямую.

Возвращает

Cake\Http\Cookie\CookieCollection

getCookieData()source public 

getCookieData( string $name )

Получение полных данных для одной куки.

Параметры

string $name
Имя значения куки.

Возвращает

array|null
Данные куки или null, если куки не определена.

getCookies()source public 

getCookies( )

Получение всех данных куки.

Возвращает

array
Данные куки

getEncoding()source public 

getEncoding( )

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

Возвращает

string|null

getJson()source public 

getJson( )

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

Возвращает

array|null

getReasonPhrase()source public 

getReasonPhrase( )

Возвращает

string
Текущая фраза причины.

getStatusCode()source public 

getStatusCode( )

Возвращает

integer
Код состояния.

getStringBody()source public 

getStringBody( )

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

Возвращает

string

getXml()source public 

getXml( )

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

Возвращает

null|SimpleXMLElement

header()source public deprecated 

header( string|null $name = null )

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

Устарело

3.3.0 Используйте getHeader() и getHeaderLine() вместо этого.

Параметры

string|null $name optional null

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

Возвращает

mixed

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


isOk()source public 

isOk( )

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

Возвращает

boolean
END_OF_DOCUMENT_MARKER

isRedirect()source public 

isRedirect( )

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

Возвращает

boolean

statusCode()source public deprecated 

statusCode( )

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

Устарело

3.3.0 Используйте getStatusCode() вместо этого.

Возвращает

целое число

version()source public deprecated 

version( )

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

Устарело

3.3.0 Используйте getProtocolVersion()

Возвращает

строка

withStatus()source public 

withStatus( integer $code , string $reasonPhrase = '' )

Параметры

целое число $code
Код состояния, который нужно установить.
строка $reasonPhrase необязательно ''
Фраза описания кода состояния.

Возвращает


$this Копия текущего объекта с обновлённым кодом состояния.

Методы, унаследованные от Cake\Http\Client\Message

cookies()source public 

cookies( )

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

Возвращает

массив

headers()source public deprecated 

headers( )

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

Устарело

3.3.0 Используйте getHeaders() вместо этого.

Возвращает

массив

Подробности свойств

$_exposedPropertiessource

protected массив

Карта имен свойств публичного доступа для __get()

[
    'cookies' => '_getCookies',
    'body' => '_getBody',
    'code' => 'code',
    'json' => '_getJson',
    'xml' => '_getXml',
    'headers' => '_getHeaders',
]

$_jsonsource

protected массив

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

$_xmlsource

protected SimpleXMLElement

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

$codesource

protected целое число

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

$cookiessource

protected Cake\Http\Cookie\CookieCollection

Экземпляр коллекции cookie

$reasonPhrasesource

protected строка

Фраза описания кода состояния

© 2005–present 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/3.8/class-Cake.Http.Client.Response.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API