StreamedResponse

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

Параметры

callable|null	$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)

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

Если текст состояния равен null, он будет автоматически заполнен для известных кодов состояний и останется пустым в противном случае.

Параметры

int	$code	Код состояния HTTP
mixed	$text	Текст состояния HTTP

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

$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

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

$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-обработчик

Исключения

LogicException