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

Ответы, помеченные как «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

$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, ответ может не быть получен из кэша без предварительной перепроверки с источником.

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

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

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)

Устанавливает заголовок HTTP Last-Modified с экземпляром 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()

Ответ OK?

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

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