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.

Response prepare(Request $request)

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

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

Параметры

Request

$request

Экземпляр Request

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

Response

Текущий ответ.

Response sendHeaders()

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

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

Response

Response sendContent()

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

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

Response

Response send()

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

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

Response

Response setContent(mixed $content)

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

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

Параметры

mixed

$content

Содержимое, которое можно привести к строке

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

Response

Исключения

UnexpectedValueException

string getContent()

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

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

string

Содержимое

Response setProtocolVersion(string $version)

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

Параметры

string

$version

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

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

Response

string getProtocolVersion()

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

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

string

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

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

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

Параметры

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

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

Response

Исключения

InvalidArgumentException

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

int getStatusCode()

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

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

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

Response setCharset(string $charset)

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

Параметры

string

$charset

Кодировка

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

Response

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

Response setPrivate()

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

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

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

Response

Response setPublic()

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

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

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

Response

bool mustRevalidate()

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

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

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

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

DateTime getDate()

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

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

DateTime

Экземпляр \DateTime

Исключения

RuntimeException

Если заголовок не может быть проанализирован

Response setDate(DateTime $date)

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

Параметры

DateTime

$date

Экземпляр \DateTime

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

Response

int getAge()

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

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

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

Response expire()

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

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

Response

DateTime|null getExpires()

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

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

DateTime|null

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

Response setExpires(DateTime $date = null)

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

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

Параметры

DateTime

$date

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

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

Response

int|null getMaxAge()

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

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

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

int|null

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

Response setMaxAge(int $value)

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

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

Параметры

int

$value

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

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

Response

Response setSharedMaxAge(int $value)

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

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

Параметры

int

$value

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

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

Response

int|null getTtl()

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

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

Если TTL ответа <= 0, ответ не может быть предоставлен из кэша без предварительной перевалидации с источником.

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

int|null

TTL в секундах

Response setTtl(int $seconds)

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

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

Параметры

int

$seconds

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

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

Response

Response setClientTtl(int $seconds)

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

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

Параметры

int

$seconds

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

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

Response

DateTime|null getLastModified()

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

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

DateTime|null

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

Исключения

RuntimeException

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

Response setLastModified(DateTime $date = null)

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

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

Параметры

DateTime

$date

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

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

Response

string|null getEtag()

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

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

string|null

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

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

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

Параметры

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

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

Response

Response setCache(array $options)

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

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

Параметры

array

$options

Массив параметров кэширования

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

Response

Исключения

InvalidArgumentException

Response setNotModified()

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

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

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

Response

См. также

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

bool hasVary()

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

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

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

array getVary()

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

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

array

Массив имён Vary

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

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

Параметры

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

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

Response

bool isNotModified(Request $request)

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

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

Параметры

Запрос

$request

Экземпляр Request

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

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

bool isInvalid()

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

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

bool

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	Очистить или сбросить буферы

Файл с двоичным содержимым setFile(SplFileInfo|string $file, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)

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

Параметры

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

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

Файл с двоичным содержимым

Исключения

Исключение файла

Файл getFile()

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

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

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

setAutoLastModified()

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

setAutoEtag()

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

Файл с двоичным содержимым setContentDisposition(string $disposition, string $filename = '', string $filenameFallback = '')

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

Параметры

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

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

Файл с двоичным содержимым

static trustXSendfileTypeHeader()

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

Файл с двоичным содержимым deleteFileAfterSend(bool $shouldDelete)

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

Параметры

bool

$shouldDelete

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

Файл с двоичным содержимым