BinaryFileResponse

__construct(SplFileInfo|string $file, int $status = 200, array $headers = array(), bool $public = true, null|string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)

Параметры

SplFileInfo|string	$file	Файл для потоковой передачи
int	$status	Код состояния ответа
array	$headers	Массив заголовков ответа
bool	$public	Файлы по умолчанию общедоступны
null|string	$contentDisposition	Тип Content-Disposition для автоматической установки с именем файла
bool	$autoEtag	Нужно ли автоматически устанавливать заголовок ETag
bool	$autoLastModified	Нужно ли автоматически устанавливать заголовок Last-Modified

static Response create(SplFileInfo|string $file = null, int $status = 200, array $headers = array(), bool $public = true, null|string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)

Параметры

SplFileInfo|string	$file	Файл для потоковой передачи
int	$status	Код состояния ответа
array	$headers	Массив заголовков ответа
bool	$public	Файлы по умолчанию общедоступны
null|string	$contentDisposition	Тип Content-Disposition для автоматической установки с именем файла
bool	$autoEtag	Нужно ли автоматически устанавливать заголовок ETag
bool	$autoLastModified	Нужно ли автоматически устанавливать заголовок Last-Modified

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

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

Отправляет файл.

{@inheritdoc}

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

$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

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

Возвращает текстовое значение 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, 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	Сбрасывать или очищать буферы

$this setFile(SplFileInfo|string $file, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)

Устанавливает файл для потоковой передачи.

Параметры

SplFileInfo|string	$file	Файл для потоковой передачи
string	$contentDisposition
bool	$autoEtag
bool	$autoLastModified

Значение возвращаемого значения

$this

Исключения

FileException

File getFile()

Получает файл.

Значение возвращаемого значения

File	Файл для потоковой передачи

setAutoLastModified()

Автоматически устанавливает заголовок Last-Modified в соответствии с датой изменения файла.

setAutoEtag()

Автоматически устанавливает заголовок ETag в соответствии с контрольной суммой файла.

$this setContentDisposition(string $disposition, string $filename = '', string $filenameFallback = '')

Устанавливает заголовок Content-Disposition с заданным именем файла.

Параметры

string	$disposition	ResponseHeaderBag::DISPOSITIONINLINE или ResponseHeaderBag::DISPOSITIONATTACHMENT
string	$filename	Необязательно использовать это имя файла в кодировке UTF-8 вместо реального имени файла
string	$filenameFallback	Имя файла по умолчанию, содержащее только символы ASCII. По умолчанию — автоматически закодированное имя файла

Значение возвращаемого значения

$this

static trustXSendfileTypeHeader()

Доверять заголовку X-Sendfile-Type.

$this deleteFileAfterSend(bool $shouldDelete)

Если это значение установлено в true, файл будет удален после отправки запроса. Примечание: если используется заголовок X-Sendfile, настройка deleteFileAfterSend не будет использоваться.

Параметры

bool

$shouldDelete

Значение возвращаемого значения

$this