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

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

$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

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

$this

string getProtocolVersion()

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

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

string

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

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

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

Параметры

int	$code
	$text

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

$this

Исключения

InvalidArgumentException

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

int getStatusCode()

Получает код состояния текущего веб-ответа.

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

int

$this setCharset(string $charset)

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

Параметры

string

$charset

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

$this

string|null getCharset()

Получает кодировку ответа.

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

string|null

bool isCacheable()

Возвращает true, если ответ может безопасно храниться в общем (суррогатном) кэше.

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

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

Обратите внимание, что RFC 7231 и RFC 7234, возможно, позволяют более гибкой реализации, например, «коды состояния, которые по умолчанию определяются как кэшируемые [...] могут быть повторно использованы кэшем с эвристической датой истечения, если не указано иное» (https://tools.ietf.org/html/rfc7231#section-6.1)

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

bool

bool isFresh()

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

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

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

bool

bool isValidateable()

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

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

bool

$this setPrivate()

Помечает ответ как «частный».

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

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

$this

$this setPublic()

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

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

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

$this

$this setImmutable(bool $immutable = true)

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

Параметры

bool

$immutable

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

$this

bool isImmutable()

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

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

bool

bool mustRevalidate()

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

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

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

bool

DateTimeInterface|null getDate()

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

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

DateTimeInterface|null

Исключения

RuntimeException

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

$this setDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface

$date

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

$this

int getAge()

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

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

int

$this expire()

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

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

$this

DateTimeInterface|null getExpires()

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

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

DateTimeInterface|null

$this setExpires(DateTimeInterface $date = null)

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

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

Параметры

DateTimeInterface

$date

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

$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

DateTimeInterface|null getLastModified()

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

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

DateTimeInterface|null

Исключения

RuntimeException

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

$this setLastModified(DateTimeInterface $date = null)

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

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

Параметры

DateTimeInterface

$date

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

$this

string|null getEtag()

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

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

string|null

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

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

Параметры

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

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

$this

$this setCache(array $options)

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

Доступные параметры: etag, last_modified, max_age, s_maxage, private, public и immutable.

Параметры

array

$options

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

$this

Исключения

InvalidArgumentException

$this setNotModified()

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

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

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

$this

См. также

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

bool hasVary()

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

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

bool

array getVary()

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

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

array

$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

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

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

protected ensureIEOverSSLCompatibility(Request $request)

Проверяет, нужно ли удалить Cache-Control для SSL-защищённых загрузок при использовании IE < 9.

Параметры

Запрос

$request

См. также

http://support.microsoft.com/kb/323308

$this setCallback(callable $callback)

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

Параметры

callable

$callback

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

Значение, возвращаемое функцией

$this