Класс ResponseEmitter
Выводит ответ на API сервера PHP.
Этот эмиттер предлагает несколько изменений по сравнению с эмиттерами, предлагаемыми diactoros:
- Он регистрирует отправленные заголовки с помощью инструментов регистрации CakePHP.
- Куки отправляются с помощью setcookie(), чтобы не возникало конфликтов с ext/session
- Cake\Http\ResponseEmitter реализует Zend\Diactoros\Response\EmitterInterface
Краткое описание методов
- emit() public
- emitBody() protectedВыводит тело сообщения.
- emitBodyRange() protectedВыводит фрагмент тела сообщения.
- emitCookies() protectedВыводит куки с помощью setcookie()
- emitHeaders() protectedВыводит заголовки ответа.
- emitStatusLine() protectedВыводит строку состояния.
- flush() protected
Проходит по буферу вывода, сбрасывая каждый, перед отправкой ответа.
- parseContentRange() protected
Разбирает заголовок content-range https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16
Подробное описание методов
emit()source public
emit( Psr\Http\Message\ResponseInterface $response , $maxBufferLength 8192 )
emitBody()source protected
emitBody( Psr\Http\Message\ResponseInterface $response , integer $maxBufferLength )
Выводит тело сообщения.
Параметры
- Psr\Http\Message\ResponseInterface
$response - Отправляемый ответ
- integer
$maxBufferLength - Размер фрагмента для отправки
emitBodyRange()source protected
emitBodyRange( array $range , Psr\Http\Message\ResponseInterface $response , integer $maxBufferLength )
Выводит фрагмент тела сообщения.
Параметры
- array
$range - Данные фрагмента для отправки
- Psr\Http\Message\ResponseInterface
$response - Отправляемый ответ
- integer
$maxBufferLength - Размер фрагмента для отправки
emitCookies()source protected
emitCookies( array $cookies )
Выводит куки с помощью setcookie()
Параметры
- array
$cookies - Массив заголовков Set-Cookie.
emitHeaders()source protected
emitHeaders( Psr\Http\Message\ResponseInterface $response )
Выводит заголовки ответа.
Проходит по каждому заголовку, отправляет каждый; если значение заголовка является массивом с несколькими значениями, гарантирует, что каждое из них отправляется таким образом, чтобы создать агрегированные заголовки (а не заменить предыдущий).
Параметры
- Psr\Http\Message\ResponseInterface
$response - Отправляемый ответ
emitStatusLine()source protected
emitStatusLine( Psr\Http\Message\ResponseInterface $response )
Выводит строку состояния.
Выводит строку состояния, используя версию протокола и код состояния из ответа; если фраза причины доступна, она также выводится.
Параметры
- Psr\Http\Message\ResponseInterface
$response - Отправляемый ответ
flush()source protected
flush( integer|null $maxBufferLevel null )
Проходит по буферу вывода, очищая каждый буфер, прежде чем передать ответ.
Параметры
- целое число|null
$maxBufferLevelнеобязательно null - Очистить до этого уровня буфера.
parseContentRange()source protected
parseContentRange( string $header )
Обработка заголовка content-range https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16
Параметры
- строка
$header - Заголовок Content-Range для обработки.
Возвращает
false|массив[единица, первая, последняя, длина]; возвращает false, если заголовок content-range отсутствует или содержит неверные данные
© 2005–2018 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.5/class-Cake.Http.ResponseEmitter.html