Spec-Zone.ru › CakePHP 3.6

Класс Response

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

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

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

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

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

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

$response->getHeaders();

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

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

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

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

$content = $response->getBody();

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

$content = $response->body;

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

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

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

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

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

$content = $response->getStatusCode();

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

$content = $response->code;
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
    Экземпляр Cookie Collection
  • $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 deprecated
    Чтение одиночных/множественных значений cookie.
  • encoding() public deprecated
    Получение кодировки, если она была установлена.
  • getCookie() public
    Получение значения одной cookie.
  • getCookieCollection() public
    Получение коллекции cookie из данного ответа.
  • getCookieData() public
    Получение полных данных для одной cookie.
  • getCookies() public
    Получение всех данных cookie.
  • getEncoding() public
    Получение кодировки, если она была установлена.
  • getReasonPhrase() public
  • getStatusCode() public
  • 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
Имя свойства.

Возвращает

булево

_decodeGzipBody()source protected 

_decodeGzipBody( string $body )

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

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

Параметры

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

Возвращает

строка

Исключение

RuntimeException
При попытке декодировать содержимое gzip без gzinflate.
END_OF_DOCUMENT_MARKER

_getBody()source protected 

_getBody( )

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

Возвращает

array

_getCookies()source protected 

_getCookies( )

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

Возвращает

array
Массив данных cookie.

_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 )

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

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

Параметры

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

body()source public 

body( callable|null $parser = null )

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

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

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

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

Параметры

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

Обработчик для декодирования тела ответа.

Возвращает

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

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

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.

Возвращает

array

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, возвращается только значение.

Возвращает

mixed

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

getReasonPhrase()source public 

getReasonPhrase( )

Возвращает

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

getStatusCode()source public 

getStatusCode( )

Возвращает

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

header()source public deprecated 

header( string|null $name = null )

Считывает значения одного/нескольких заголовков.

Устаревший

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

Параметры

строка|null $name необязательный null

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

Возвращает

mixed

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


isOk()source public 

isOk( )

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

Возвращает

булево

isRedirect()source public 

isRedirect( )

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

Возвращает

булево

statusCode()source public deprecated 

statusCode( )

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

Устаревший

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

Возвращает

целое число
END_OF_DOCUMENT_MARKER

version()source public deprecated 

version( )

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

Устарело

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

Возвращает

string

withStatus()source public 

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

Параметры

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

Возвращает


$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

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

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

Spec-Zone.ru

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