BinaryFileResponse
class BinaryFileResponse extends Response
BinaryFileResponse представляет HTTP-ответ, передающий файл.
Методы
| __construct(SplFileInfo|string $file, int $status = 200, array $headers = array(), bool $public = true, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true) | ||
| static BinaryFileResponse | create(SplFileInfo|string $file = null, int $status = 200, array $headers = array(), bool $public = true, null|string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true) | |
| $this | setFile(SplFileInfo|string $file, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true) Устанавливает файл для потоковой передачи. | |
| File | getFile() Получает файл. | |
| setAutoLastModified() Автоматически устанавливает заголовок Last-Modified в соответствии с датой изменения файла. | ||
| setAutoEtag() Автоматически устанавливает заголовок ETag в соответствии с контрольной суммой файла. | ||
| $this | setContentDisposition(string $disposition, string $filename = '', string $filenameFallback = '') Устанавливает заголовок Content-Disposition с указанным именем файла. | |
| prepare(Request $request) {@inheritdoc} | ||
| sendContent() Отправляет файл. | ||
| setContent($content) {@inheritdoc} | ||
| false | getContent() {@inheritdoc} | |
| static | trustXSendfileTypeHeader() Доверяет заголовку X-Sendfile-Type. | |
| $this | deleteFileAfterSend(bool $shouldDelete) Если установлено значение true, файл будет удалён после отправки запроса. Примечание: если используется заголовок X-Sendfile, значение deleteFileAfterSend не будет использоваться. |
Подробности
__construct(SplFileInfo|string $file, int $status = 200, array $headers = array(), bool $public = true, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)
Параметры
| SplFileInfo|string | $file | Файл для потоковой передачи |
| int | $status | Код состояния ответа |
| array | $headers | Массив заголовков ответа |
| bool | $public | Файлы по умолчанию публичные |
| string | $contentDisposition | Тип Content-Disposition для автоматического задания с именем файла |
| bool | $autoEtag | Автоматически устанавливать заголовок ETag |
| bool | $autoLastModified | Автоматически устанавливать заголовок Last-Modified |
static BinaryFileResponse 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 |
Возвращаемое значение
| BinaryFileResponse |
$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 |
prepare(Request $request)
{@inheritdoc}
Параметры
| Request | $request |
sendContent()
Отправляет файл.
{@inheritdoc}
setContent($content)
{@inheritdoc}
Параметры
| $content |
Исключения
| LogicException | при не null значении контента |
false getContent()
{@inheritdoc}
Возвращаемое значение
| false |
static trustXSendfileTypeHeader()
Доверяет заголовку X-Sendfile-Type.
$this deleteFileAfterSend(bool $shouldDelete)
Если установлено значение true, файл будет удалён после отправки запроса. Примечание: если используется заголовок X-Sendfile, значение deleteFileAfterSend не будет использоваться.
Параметры
| bool | $shouldDelete |
Возвращаемое значение
| $this |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpFoundation/BinaryFileResponse.html