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)

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

Если текст статуса равен 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, если ответ подходит для кэширования в любом случае.

Ответы, помеченные как «приватные» с явным директивой 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()

Помечает ответ как «приватный».

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

Значение результата

$this

$this setPublic()

Помечает ответ как «публичный».

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

Значение результата

$this

$this setImmutable(bool $immutable = true)

Помечает ответ как «неизменяемый».

Параметры

bool

$immutable

включает или отключает директиву immutable

Значение результата

$this

bool isImmutable()

Возвращает true, если ответ помечен как «неизменяемый».

Значение результата

bool	возвращает true, если ответ помечен как «неизменяемый»; в противном случае false

bool mustRevalidate()

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

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

Значение результата

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

Возвращает HTTP-заголовок Last-Modified в виде экземпляра DateTime.

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

DateTime|null

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

Исключения

RuntimeException

Когда HTTP-заголовок не может быть распарсен

$this setLastModified(DateTime $date = null)

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

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

Параметры

DateTime

$date

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

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

$this

string|null getEtag()

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

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

string|null

HTTP-заголовок ETag или 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, last_modified, max_age, 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	Выполнить сброс или очистку буферов

$this setCallback(callable $callback)

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

Параметры

callable

$callback

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

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

$this