[ Index ]

PHP Cross Reference of phpBB-3.3.3-deutsch

title

Body

[close]

/vendor/symfony/http-foundation/ -> BinaryFileResponse.php (summary)

(no description)

File Size: 364 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BinaryFileResponse:: (14 methods):
  __construct()
  create()
  setFile()
  getFile()
  setAutoLastModified()
  setAutoEtag()
  setContentDisposition()
  prepare()
  hasValidIfRangeHeader()
  sendContent()
  setContent()
  getContent()
  trustXSendfileTypeHeader()
  deleteFileAfterSend()


Class: BinaryFileResponse  - X-Ref

BinaryFileResponse represents an HTTP response delivering a file.

__construct($file, $status = 200, $headers = [], $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)   X-Ref

param: \SplFileInfo|string $file               The file to stream
param: int                 $status             The response status code
param: array               $headers            An array of response headers
param: bool                $public             Files are public by default
param: string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
param: bool                $autoEtag           Whether the ETag header should be automatically set
param: bool                $autoLastModified   Whether the Last-Modified header should be automatically set

create($file = null, $status = 200, $headers = [], $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)   X-Ref

return: static
param: \SplFileInfo|string $file               The file to stream
param: int                 $status             The response status code
param: array               $headers            An array of response headers
param: bool                $public             Files are public by default
param: string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
param: bool                $autoEtag           Whether the ETag header should be automatically set
param: bool                $autoLastModified   Whether the Last-Modified header should be automatically set

setFile($file, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)   X-Ref
Sets the file to stream.

return: $this
param: \SplFileInfo|string $file               The file to stream
param: string              $contentDisposition
param: bool                $autoEtag
param: bool                $autoLastModified

getFile()   X-Ref
Gets the file.

return: File The file to stream

setAutoLastModified()   X-Ref
Automatically sets the Last-Modified header according the file modification date.


setAutoEtag()   X-Ref
Automatically sets the ETag header according to the checksum of the file.


setContentDisposition($disposition, $filename = '', $filenameFallback = '')   X-Ref
Sets the Content-Disposition header with the given filename.

return: $this
param: string $disposition      ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
param: string $filename         Optionally use this UTF-8 encoded filename instead of the real name of the file
param: string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename

prepare(Request $request)   X-Ref
{@inheritdoc}


hasValidIfRangeHeader($header)   X-Ref
No description

sendContent()   X-Ref
Sends the file.

{@inheritdoc}

setContent($content)   X-Ref
{@inheritdoc}


getContent()   X-Ref
{@inheritdoc}


trustXSendfileTypeHeader()   X-Ref
Trust X-Sendfile-Type header.


deleteFileAfterSend($shouldDelete)   X-Ref
If this is set to true, the file will be unlinked after the request is sent
Note: If the X-Sendfile header is used, the deleteFileAfterSend setting will not be used.

return: $this
param: bool $shouldDelete



Generated: Sun Feb 14 20:08:31 2021 Cross-referenced by PHPXref 0.7.1