Spec-Zone.ru › CakePHP 3.4

Класс 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_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
    Экземпляр 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
    Получение кодировки, если она была установлена.
  • getReasonPhrase() public
  • getStatusCode() public
  • 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.

_getBody()source protected 

_getBody( )

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

Возвращает

массив

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

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

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

Параметры

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

body()source public 

body( callable|null $parser null )

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

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

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

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

Параметры

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

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

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

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

Устарело

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

Параметры

string|null $name необязательно null

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

boolean $all необязательно false

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

Возвращает

mixed

encoding()source public 

encoding( )

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

Устарело

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

Возвращает

string|null

getCookie()source public 

getCookie( string $name )

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

Параметры

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

Возвращает

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

getCookieCollection()source public 

getCookieCollection( )

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

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

Возвращает

Cake\Http\Cookie\CookieCollection

getCookieData()source public 

getCookieData( string $name )

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

Параметры

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

Возвращает

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

getCookies()source public 

getCookies( )

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

Возвращает

array
Данные cookie

getEncoding()source public 

getEncoding( )

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

Возвращает

string|null

getReasonPhrase()source public 

getReasonPhrase( )

Возвращает

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

getStatusCode()source public 

getStatusCode( )

Возвращает

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

header()source public 

header( string|null $name null )

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

Устарело

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

Параметры

string|null $name необязательно null

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

Возвращает

mixed

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


isOk()source public 

isOk( )

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

Возвращает

boolean

isRedirect()source public 

isRedirect( )

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

Возвращает

boolean

statusCode()source public 

statusCode( )

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

Устарело

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

Возвращает

integer

version()source public 

version( )

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

Устарело

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

Возвращает

string
END_OF_DOCUMENT_MARKER

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 

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

Spec-Zone.ru

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