Класс ResponseEmitter
Выводит ответ на API сервера PHP.
Этот эмиттер предлагает несколько изменений по сравнению с эмиттерами, предлагаемыми diactoros:
- Он регистрирует отправленные заголовки с помощью инструментов регистрации CakePHP.
- Куки отправляются с помощью setcookie(), чтобы не конфликтовать с ext/session
Краткое описание свойств
- $maxBufferLength protected
intМаксимальный размер буферизации вывода для каждой итерации.
Краткое описание методов
-
__construct() public
Конструктор
-
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
-
setCookie() protected
Вспомогательные методы для установки куки.
Подробное описание методов
__construct() public
__construct(int $maxBufferLength = 8192)
Конструктор
Параметры
-
int$maxBufferLength optional Максимальный размер буферизации вывода для каждой итерации.
emit() public
emit(ResponseInterface $response): bool
Вывести ответ.
Выводит ответ, включая строку состояния, заголовки и тело сообщения в соответствии со средой.
Параметры
-
ResponseInterface$response Ответ для вывода.
Возвращает
boolemitBody() protected
emitBody(Psr\Http\Message\ResponseInterface $response): void
Вывести тело сообщения.
Параметры
-
Psr\Http\Message\ResponseInterface$response Ответ для вывода
Возвращает
voidemitBodyRange() protected
emitBodyRange(array $range, Psr\Http\Message\ResponseInterface $response): void
Вывести диапазон тела сообщения.
Параметры
-
array$range Данные диапазона для вывода
-
Psr\Http\Message\ResponseInterface$response Ответ для вывода
Возвращает
voidemitCookies() protected
emitCookies(arrayCake\Http\Cookie\CookieInterface|string> $cookies): void
Вывести куки с помощью setcookie()
Параметры
-
arrayCake\Http\Cookie\CookieInterface|string>$cookies Массив куки.
Возвращает
voidemitHeaders() protected
emitHeaders(Psr\Http\Message\ResponseInterface $response): void
Вывести заголовки ответа.
Проходит по каждому заголовку, выводя каждый; если значение заголовка является массивом с несколькими значениями, гарантирует, что каждый отправляется таким образом, чтобы создать агрегированные заголовки (вместо замены предыдущих).
Параметры
-
Psr\Http\Message\ResponseInterface$response Ответ для вывода
Возвращает
voidemitStatusLine() protected
emitStatusLine(Psr\Http\Message\ResponseInterface $response): void
Вывести строку состояния.
Выводит строку состояния, используя версию протокола и код состояния из ответа; если доступна фраза причины, она также выводится.
Параметры
-
Psr\Http\Message\ResponseInterface$response Ответ для вывода
Возвращает
voidflush() protected
flush(int|null $maxBufferLevel = null): void
Проходит по буферу вывода, очищая каждый, прежде чем выводить ответ.
Параметры
-
int|null$maxBufferLevel optional Очистить до этого уровня буфера.
Возвращает
voidparseContentRange() protected
parseContentRange(string $header): array|false
Разбирать заголовок content-range https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16
Параметры
-
string$header Заголовок Content-Range для разбора.
Возвращает
array|falsesetCookie() protected
setCookie(Cake\Http\Cookie\CookieInterface|string $cookie): bool
Вспомогательные методы для установки куки.
Параметры
-
Cake\Http\Cookie\CookieInterface|string$cookie Cookie.
Возвращает
boolПодробное описание свойств
$maxBufferLength protected
Максимальный размер буферизации вывода для каждой итерации.
Тип
int
© 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/4.4/class-Cake.Http.ResponseEmitter.html
