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)

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

Параметры

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

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

$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, если ответ содержит заголовки, которые могут использоваться для проверки ответа с сервером-источником с помощью запроса conditional GET.

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

bool	true, если ответ подходит для проверки, иначе false

$this setPrivate()

Помечает ответ как «private».

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

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

$this

$this setPublic()

Помечает ответ как «public».

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

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

$this

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

Возвращает заголовок 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()

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

Очищает или сбрасывает буферы вывода до уровня `target`.

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

Параметры

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