Spec-Zone.ru › CakePHP 3.7

Класс 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
Extended by 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
    Карта публичных => имена свойств для __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 deprecated
    Получение тела ответа.
  • buildCookieCollection() protected
    Ленивая сборка CookieCollection и объектов куки из заголовка ответа
  • convertCookieToArray() protected
    Преобразует куки в массив его свойств.
  • cookie() public deprecated
    Чтение значений одного/нескольких куки.
  • encoding() public deprecated
    Получение кодировки, если она была установлена.
  • getCookie() public
    Получение значения одной куки.
  • getCookieCollection() public
    Получение коллекции куки из этого ответа.
  • getCookieData() public
    Получение полных данных для одной куки.
  • getCookies() public
    Получение всех данных куки.
  • getEncoding() public
    Получение кодировки, если она была установлена.
  • getJson() public
    Получение тела ответа как декодированных данных JSON.
  • getReasonPhrase() public
  • getStatusCode() public
  • getStringBody() public
    Получение тела ответа в виде строки.
  • getXml() public
    Получение тела ответа как декодированных данных XML.
  • header() public deprecated
    Чтение значения(й) одного/нескольких заголовков.
  • isOk() public
    Проверка, был ли ответ OK
  • isRedirect() public
    Проверка, был ли ответ редиректом.
  • statusCode() public deprecated
    Получение кода состояния из ответа
  • version() public deprecated
    Получение используемой версии 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
Имя свойства.

Возвращает

булево
END_OF_DOCUMENT_MARKER

_decodeGzipBody()source protected 

_decodeGzipBody( string $body )

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

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

Параметры

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

Возвращает

строку

Исключения

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

_getBody()source protected 

_getBody( )

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

Возвращает

строку

_getCookies()source protected 

_getCookies( )

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

Возвращает

массив
Массив данных Cookie.

_getHeaders()source protected 

_getHeaders( )

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

Возвращает

массив

_getJson()source protected 

_getJson( )

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

Возвращает

массив|null

_getXml()source protected 

_getXml( )

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

Возвращает

null|SimpleXMLElement

_parseHeaders()source protected 

_parseHeaders( array $headers )

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

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

Параметры

массив $headers
Заголовки для обработки.

body()source public deprecated 

body( callable|null $parser = null )

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

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

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

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

Устарело

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

Параметры

вызываемая функция|null $parser опционально null

Обработчик, который нужно использовать для декодирования тела ответа.

Возвращает

смешанное
Тело ответа.

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

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

buildCookieCollection()source protected 

buildCookieCollection( )

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

convertCookieToArray()source protected 

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

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

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

Параметры

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

Возвращает

массив

cookie()source public deprecated 

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

Чтение одиночного/множественного значения cookie.

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

Устарело

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

Параметры

строка|null $name опционально null

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

логическое $all опционально false

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

Возвращает

смешанное

encoding()source public deprecated 

encoding( )

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

Устарело

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

Возвращает

строка|null

getCookie()source public 

getCookie( string $name )

Получить значение одного cookie.

Параметры

строка $name
Имя значения cookie.

Возвращает

строка|массив|null
Значение cookie или null, если cookie не определено.

getCookieCollection()source public 

getCookieCollection( )

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

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

Возвращает

Cake\Http\Cookie\CookieCollection

getCookieData()source public 

getCookieData( string $name )

Получить полные данные для одного cookie.

Параметры

строка $name
Имя значения cookie.

Возвращает

массив|null
Данные cookie или null, если cookie не определено.

getCookies()source public 

getCookies( )

Получить все данные cookie.

Возвращает

массив
Данные cookie

getEncoding()source public 

getEncoding( )

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

Возвращает

строка|null

getJson()source public 

getJson( )

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

Возвращает

массив|null

getReasonPhrase()source public 

getReasonPhrase( )

Возвращает

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

getStatusCode()source public 

getStatusCode( )

Возвращает

целое число
Код состояния.

getStringBody()source public 

getStringBody( )

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

Возвращает

строка

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

isRedirect()source public 

isRedirect( )

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

Возвращает

boolean

statusCode()source public deprecated 

statusCode( )

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

Устаревшее

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

Возвращает

integer

version()source public deprecated 

version( )

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

Устаревшее

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

Возвращает

string

withStatus()source public 

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

Параметры

integer $code
Код состояния для установки.
string $reasonPhrase optional ''
Фраза описания состояния.

Возвращает


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

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

cookies()source public 

cookies( )

Получение всех куки

Возвращает

array

headers()source public deprecated 

headers( )

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

Устаревшее

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

Возвращает

array

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

$_exposedPropertiessource

protected array

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

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

$_jsonsource

protected array

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

$_xmlsource

protected SimpleXMLElement

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

$codesource

protected integer

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

$cookiessource

protected Cake\Http\Cookie\CookieCollection

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

$reasonPhrasesource

protected string

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

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

Spec-Zone.ru

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