StreamedResponse

__construct(callable $callback = null, int $status = 200, array $headers = array())

Конструктор.

Параметры

callable	$callback	Действительный PHP-обработчик или null для установки его позже
int	$status	Код состояния ответа
array	$headers	Массив заголовков ответа

static Response create(callable|null $callback = null, int $status = 200, array $headers = array())

Метод-фабрика для цепочки вызовов.

Параметры

callable|null	$callback	Действительный PHP-обработчик или null для установки его позже
int	$status	Код состояния ответа
array	$headers	Массив заголовков ответа

Возвращаемое значение

Response

string __toString()

Возвращает ответ как строку HTTP.

Строковое представление ответа совпадает со строкой, которая будет отправлена клиенту, только если метод prepare() был вызван предварительно.

Возвращаемое значение

string

Ответ как строка HTTP

См. также

prepare()

__clone()

Клонирует текущий экземпляр Response.

$this prepare(Request $request)

Подготавливает ответ перед отправкой клиенту.

Этот метод изменяет ответ, чтобы гарантировать соответствие RFC 2616. Большинство изменений основаны на запросе, который «связан» с этим ответом.

Параметры

Request

$request

Экземпляр Request

Возвращаемое значение

$this

$this sendHeaders()

Отправляет HTTP-заголовки.

Возвращаемое значение

$this

$this sendContent()

Отправляет содержимое для текущего веб-ответа.

Возвращаемое значение

$this

$this send()

Отправляет HTTP-заголовки и содержимое.

Возвращаемое значение

$this

$this setContent(mixed $content)

Устанавливает содержимое ответа.

Допустимые типы — строки, числа, null и объекты, реализующие метод __toString().

Параметры

mixed

$content

Содержимое, которое может быть преобразовано в строку

Возвращаемое значение

$this

Исключения

UnexpectedValueException

string getContent()

Получает текущее содержимое ответа.

Возвращаемое значение

string

Содержимое

$this setProtocolVersion(string $version)

Устанавливает версию протокола HTTP (1.0 или 1.1).

Параметры

string

$version

Версия протокола HTTP

Возвращаемое значение

$this

string getProtocolVersion()

Получает версию протокола HTTP.

Возвращаемое значение

string

Версия протокола HTTP

$this setStatusCode(int $code, mixed $text = null)

Устанавливает код состояния ответа.

Параметры

int	$code	Код состояния HTTP
mixed	$text	Текст состояния HTTP Если текст состояния null, он будет автоматически заполнен для известных кодов состояний и останется пустым в противном случае.

Возвращаемое значение

$this

Исключения

InvalidArgumentException

При некорректном коде состояния HTTP

int getStatusCode()

Возвращает код состояния текущего веб-ответа.

Возвращаемое значение

int	Код состояния

$this setCharset(string $charset)

Устанавливает кодировку ответа.

Параметры

string

$charset

Кодировка символов

Возвращаемое значение

$this

string getCharset()

Возвращает кодировку символов ответа.

Возвращаемое значение

string

Кодировка символов

bool isCacheable()

Возвращает true, если ответ подходит для кэширования при любых обстоятельствах.

Ответы, помеченные как «private» с явным направлением Cache-Control, считаются некэшируемыми.

Ответы без срока годности кэша (Expires, max-age) или валидатора кэша (Last-Modified, ETag) считаются некэшируемыми.

Возвращаемое значение

bool	true, если ответ подходит для кэширования, false в противном случае

bool isFresh()

Возвращает true, если ответ «свежий».

Свежие ответы могут быть возвращены из кэша без взаимодействия с источником. Ответ считается свежим, если он содержит показатель Cache-Control/max-age или заголовок Expires, и рассчитанный возраст меньше срока годности.

Возвращаемое значение

bool	true, если ответ свежий, false в противном случае

bool isValidateable()

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

Возвращаемое значение

bool	true, если ответ проверяем, false в противном случае

$this setPrivate()

Помечает ответ как «private».

Это делает ответ недоступным для других клиентов.

Возвращаемое значение

$this

$this setPublic()

Помечает ответ как «public».

Это делает ответ доступным для других клиентов.

Возвращаемое значение

$this

bool mustRevalidate()

Возвращает true, если ответ должен быть перепроверен кэшами.

Этот метод указывает, что ответ не должен отображаться устаревшим кэшем ни при каких обстоятельствах без предварительной перепроверки у источника. Если указан, TTL ответа не должен быть больше значения, предоставленного источником.

Возвращаемое значение

bool	true, если ответ должен быть перепроверен кэшем, false в противном случае

DateTime getDate()

Возвращает заголовок Date как экземпляр DateTime.

Возвращаемое значение

DateTime

Экземпляр \DateTime

Исключения

RuntimeException

При невозможности анализа заголовка

$this setDate(DateTime $date)

Устанавливает заголовок Date.

Параметры

DateTime

$date

Экземпляр \DateTime

Возвращаемое значение

$this

int getAge()

Возвращает возраст ответа.

Возвращаемое значение

int	Возраст ответа в секундах

$this expire()

Помечает ответ устаревшим, установив заголовок Age равным максимальному возрасту ответа.

Возвращаемое значение

$this

DateTime|null getExpires()

Возвращает значение заголовка Expires как экземпляр DateTime.

Возвращаемое значение

DateTime|null

Экземпляр DateTime или null, если заголовок отсутствует

$this setExpires(DateTime $date = null)

Устанавливает заголовок HTTP Expires с помощью экземпляра DateTime.

Передача null как значения удалит заголовок.

Параметры

DateTime

$date

Экземпляр \DateTime или null для удаления заголовка

Возвращаемое значение

$this

int|null getMaxAge()

Возвращает количество секунд после времени, указанного в заголовке Date ответа, когда ответ больше не должен считаться свежим.

Сначала проверяется директива s-maxage, затем директива max-age, а затем используется заголовок expires. Возвращает null, когда максимальный срок действия не может быть установлен.

Значение возврата

int|null

Количество секунд

$this setMaxAge(int $value)

Устанавливает количество секунд, после которого ответ больше не должен считаться свежим.

Этот метод устанавливает директиву Cache-Control max-age.

Параметры

int

$value

Количество секунд

Значение возврата

$this

$this setSharedMaxAge(int $value)

Устанавливает количество секунд, после которого ответ больше не должен считаться свежим для общих кэшей.

Этот метод устанавливает директиву Cache-Control s-maxage.

Параметры

int

$value

Количество секунд

Значение возврата

$this

int|null getTtl()

Возвращает время жизни ответа в секундах.

Возвращает null, когда в ответе отсутствует информация о свежести.

Когда время жизни ответа (TTL) <= 0, ответ не может быть получен из кэша без предварительной перепроверки у источника.

Значение возврата

int|null

Время жизни (TTL) в секундах

$this setTtl(int $seconds)

Устанавливает время жизни ответа для общих кэшей.

Этот метод изменяет директиву Cache-Control/s-maxage.

Параметры

int

$seconds

Количество секунд

Значение возврата

$this

$this setClientTtl(int $seconds)

Устанавливает время жизни ответа для частных/клиентских кэшей.

Этот метод изменяет директиву Cache-Control/max-age.

Параметры

int

$seconds

Количество секунд

Значение возврата

$this

DateTime|null getLastModified()

Возвращает заголовок Last-Modified HTTP в виде объекта DateTime.

Значение возврата

DateTime|null

Объект DateTime или null, если заголовок не существует

Исключения

RuntimeException

При невозможности распарсить HTTP заголовок

$this setLastModified(DateTime $date = null)

Устанавливает заголовок Last-Modified HTTP с помощью объекта DateTime.

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

Параметры

DateTime

$date

Объект \DateTime или null для удаления заголовка

Значение возврата

$this

string|null getEtag()

Возвращает буквальное значение заголовка ETag HTTP.

Значение возврата

string|null

Заголовок ETag HTTP или null, если он не существует

$this setEtag(string|null $etag = null, bool $weak = false)

Устанавливает значение ETag.

Параметры

string|null	$etag	Уникальный идентификатор ETag или null для удаления заголовка
bool	$weak	Нужно ли использовать слабый ETag

Значение возврата

$this

$this setCache(array $options)

Устанавливает заголовки кэширования ответа (валидация и/или срок действия).

Доступные опции: etag, lastmodified, maxage, s_maxage, private и public.

Параметры

array

$options

Массив опций кэширования

Значение возврата

$this

Исключения

InvalidArgumentException

$this setNotModified()

Изменяет ответ так, чтобы он соответствовал правилам, определённым для кода состояния 304.

Устанавливает состояние, удаляет тело и отбрасывает любые заголовки, которые НЕ ДОЛЖНЫ включаться в ответы 304.

Значение возврата

$this

См. также

http://tools.ietf.org/html/rfc2616#section-10.3.5

bool hasVary()

Возвращает true, если ответ включает заголовок Vary.

Значение возврата

bool	true, если ответ включает заголовок Vary, иначе false

array getVary()

Возвращает массив имён заголовков, указанных в заголовке Vary.

Значение возврата

array

Массив имён Vary

$this setVary(string|array $headers, bool $replace = true)

Устанавливает заголовок Vary.

Параметры

string|array	$headers
bool	$replace	Заменять ли фактическое значение (по умолчанию true)

Значение возврата

$this

bool isNotModified(Request $request)

Определяет, соответствуют ли валидаторы ответа (ETag, Last-Modified) условным значениям, указанным в запросе.

Если ответ не изменён, устанавливает код состояния 304 и удаляет фактическое содержимое, вызвав метод setNotModified().

Параметры

Request

$request

Экземпляр Request

Значение возврата

bool	true, если валидаторы ответа соответствуют запросу, иначе false

bool isInvalid()

Недействителен ли ответ?

Значение возврата

bool

См. также

http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

bool isInformational()

Информативен ли ответ?

Значение возврата

bool

bool isSuccessful()

Успешен ли ответ?

Значение возврата

bool

bool isRedirection()

Является ли ответ перенаправлением?

Значение возврата

bool

bool isClientError()

Есть ли ошибка клиента?

Значение возврата

bool

bool isServerError()

Была ли ошибка на стороне сервера?

Значение возврата

bool

bool isOk()

Успешен ли ответ?

Значение возврата

bool

bool isForbidden()

Запрещён ли ответ?

Значение возврата

bool

bool isNotFound()

Является ли ответ ошибкой "не найдено"?

Значение возврата

bool

bool isRedirect(string $location = null)

Является ли ответ перенаправлением?

Параметры

string

$location

Значение возврата

bool

bool isEmpty()

Пустой ли ответ?

Значение возврата

bool

static closeOutputBuffers(int $targetLevel, bool $flush)

Очищает или сбрасывает буферы вывода до заданного уровня.

Результирующий уровень может быть больше целевого уровня, если был встречен не удаляемый буфер.

Параметры

int	$targetLevel	Целевой уровень буферизации вывода
bool	$flush	Сбрасывать или очищать буферы

setCallback(callable $callback)

Устанавливает PHP обратный вызов, связанный с этим ответом.

Параметры

callable

$callback

Действительный PHP обратный вызов