Open Journal Systems  3.3.0
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
Symfony\Component\HttpFoundation\BinaryFileResponse Class Reference
Inheritance diagram for Symfony\Component\HttpFoundation\BinaryFileResponse:
Symfony\Component\HttpFoundation\Response

Public Member Functions

 __construct ($file, $status=200, $headers=array(), $public=true, $contentDisposition=null, $autoEtag=false, $autoLastModified=true)
 
 __construct ($file, int $status=200, array $headers=[], bool $public=true, string $contentDisposition=null, bool $autoEtag=false, bool $autoLastModified=true)
 
 deleteFileAfterSend ($shouldDelete)
 
 deleteFileAfterSend ($shouldDelete=true)
 
 getContent ()
 
 getContent ()
 
 getFile ()
 
 getFile ()
 
 prepare (Request $request)
 
 prepare (Request $request)
 
 sendContent ()
 
 sendContent ()
 
 setAutoEtag ()
 
 setAutoEtag ()
 
 setAutoLastModified ()
 
 setAutoLastModified ()
 
 setContent ($content)
 
 setContent ($content)
 
 setContentDisposition ($disposition, $filename='', $filenameFallback='')
 
 setContentDisposition ($disposition, $filename='', $filenameFallback='')
 
 setFile ($file, $contentDisposition=null, $autoEtag=false, $autoLastModified=true)
 
 setFile ($file, $contentDisposition=null, $autoEtag=false, $autoLastModified=true)
 
- Public Member Functions inherited from Symfony\Component\HttpFoundation\Response
 __clone ()
 
 __clone ()
 
 __construct ($content='', $status=200, $headers=array())
 
 __construct ($content='', int $status=200, array $headers=[])
 
 __toString ()
 
 __toString ()
 
 expire ()
 
 expire ()
 
 getAge ()
 
 getAge ()
 
 getCharset ()
 
 getCharset ()
 
 getDate ()
 
 getDate ()
 
 getEtag ()
 
 getEtag ()
 
 getExpires ()
 
 getExpires ()
 
 getLastModified ()
 
 getLastModified ()
 
 getMaxAge ()
 
 getMaxAge ()
 
 getProtocolVersion ()
 
 getProtocolVersion ()
 
 getStatusCode ()
 
 getStatusCode ()
 
 getTtl ()
 
 getTtl ()
 
 getVary ()
 
 getVary ()
 
 hasVary ()
 
 hasVary ()
 
 isCacheable ()
 
 isCacheable ()
 
 isClientError ()
 
 isClientError ()
 
 isEmpty ()
 
 isEmpty ()
 
 isForbidden ()
 
 isForbidden ()
 
 isFresh ()
 
 isFresh ()
 
 isImmutable ()
 
 isInformational ()
 
 isInformational ()
 
 isInvalid ()
 
 isInvalid ()
 
 isNotFound ()
 
 isNotFound ()
 
 isNotModified (Request $request)
 
 isNotModified (Request $request)
 
 isOk ()
 
 isOk ()
 
 isRedirect ($location=null)
 
 isRedirect (string $location=null)
 
 isRedirection ()
 
 isRedirection ()
 
 isServerError ()
 
 isServerError ()
 
 isSuccessful ()
 
 isSuccessful ()
 
 isValidateable ()
 
 isValidateable ()
 
 mustRevalidate ()
 
 mustRevalidate ()
 
 send ()
 
 send ()
 
 sendHeaders ()
 
 sendHeaders ()
 
 setCache (array $options)
 
 setCache (array $options)
 
 setCharset ($charset)
 
 setCharset (string $charset)
 
 setClientTtl ($seconds)
 
 setClientTtl (int $seconds)
 
 setDate (\DateTime $date)
 
 setDate (\DateTimeInterface $date)
 
 setEtag ($etag=null, $weak=false)
 
 setEtag (string $etag=null, bool $weak=false)
 
 setExpires (\DateTime $date=null)
 
 setExpires (\DateTimeInterface $date=null)
 
 setImmutable (bool $immutable=true)
 
 setLastModified (\DateTime $date=null)
 
 setLastModified (\DateTimeInterface $date=null)
 
 setMaxAge ($value)
 
 setMaxAge (int $value)
 
 setNotModified ()
 
 setNotModified ()
 
 setPrivate ()
 
 setPrivate ()
 
 setProtocolVersion ($version)
 
 setProtocolVersion (string $version)
 
 setPublic ()
 
 setPublic ()
 
 setSharedMaxAge ($value)
 
 setSharedMaxAge (int $value)
 
 setStatusCode ($code, $text=null)
 
 setStatusCode (int $code, $text=null)
 
 setTtl ($seconds)
 
 setTtl (int $seconds)
 
 setVary ($headers, $replace=true)
 
 setVary ($headers, bool $replace=true)
 

Static Public Member Functions

static create ($file=null, $status=200, $headers=[], $public=true, $contentDisposition=null, $autoEtag=false, $autoLastModified=true)
 
static create ($file=null, $status=200, $headers=array(), $public=true, $contentDisposition=null, $autoEtag=false, $autoLastModified=true)
 
static trustXSendfileTypeHeader ()
 
static trustXSendfileTypeHeader ()
 
- Static Public Member Functions inherited from Symfony\Component\HttpFoundation\Response
static closeOutputBuffers ($targetLevel, $flush)
 
static closeOutputBuffers (int $targetLevel, bool $flush)
 
static create ($content='', $status=200, $headers=[])
 
static create ($content='', $status=200, $headers=array())
 

Protected Attributes

 $deleteFileAfterSend = false
 
 $file
 
 $maxlen = -1
 
 $offset = 0
 
- Protected Attributes inherited from Symfony\Component\HttpFoundation\Response
 $charset
 
 $content
 
 $statusCode
 
 $statusText
 
 $version
 

Static Protected Attributes

static $trustXSendfileTypeHeader = false
 

Additional Inherited Members

- Data Fields inherited from Symfony\Component\HttpFoundation\Response
 $headers
 
const HTTP_ACCEPTED = 202
 
const HTTP_ALREADY_REPORTED = 208
 
const HTTP_BAD_GATEWAY = 502
 
const HTTP_BAD_REQUEST = 400
 
const HTTP_CONFLICT = 409
 
const HTTP_CONTINUE = 100
 
const HTTP_CREATED = 201
 
const HTTP_EARLY_HINTS = 103
 
const HTTP_EXPECTATION_FAILED = 417
 
const HTTP_FAILED_DEPENDENCY = 424
 
const HTTP_FORBIDDEN = 403
 
const HTTP_FOUND = 302
 
const HTTP_GATEWAY_TIMEOUT = 504
 
const HTTP_GONE = 410
 
const HTTP_I_AM_A_TEAPOT = 418
 
const HTTP_IM_USED = 226
 
const HTTP_INSUFFICIENT_STORAGE = 507
 
const HTTP_INTERNAL_SERVER_ERROR = 500
 
const HTTP_LENGTH_REQUIRED = 411
 
const HTTP_LOCKED = 423
 
const HTTP_LOOP_DETECTED = 508
 
const HTTP_METHOD_NOT_ALLOWED = 405
 
const HTTP_MISDIRECTED_REQUEST = 421
 
const HTTP_MOVED_PERMANENTLY = 301
 
const HTTP_MULTI_STATUS = 207
 
const HTTP_MULTIPLE_CHOICES = 300
 
const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511
 
const HTTP_NO_CONTENT = 204
 
const HTTP_NON_AUTHORITATIVE_INFORMATION = 203
 
const HTTP_NOT_ACCEPTABLE = 406
 
const HTTP_NOT_EXTENDED = 510
 
const HTTP_NOT_FOUND = 404
 
const HTTP_NOT_IMPLEMENTED = 501
 
const HTTP_NOT_MODIFIED = 304
 
const HTTP_OK = 200
 
const HTTP_PARTIAL_CONTENT = 206
 
const HTTP_PAYMENT_REQUIRED = 402
 
const HTTP_PERMANENTLY_REDIRECT = 308
 
const HTTP_PRECONDITION_FAILED = 412
 
const HTTP_PRECONDITION_REQUIRED = 428
 
const HTTP_PROCESSING = 102
 
const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407
 
const HTTP_REQUEST_ENTITY_TOO_LARGE = 413
 
const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431
 
const HTTP_REQUEST_TIMEOUT = 408
 
const HTTP_REQUEST_URI_TOO_LONG = 414
 
const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416
 
const HTTP_RESERVED = 306
 
const HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425
 
const HTTP_RESET_CONTENT = 205
 
const HTTP_SEE_OTHER = 303
 
const HTTP_SERVICE_UNAVAILABLE = 503
 
const HTTP_SWITCHING_PROTOCOLS = 101
 
const HTTP_TEMPORARY_REDIRECT = 307
 
const HTTP_TOO_EARLY = 425
 
const HTTP_TOO_MANY_REQUESTS = 429
 
const HTTP_UNAUTHORIZED = 401
 
const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451
 
const HTTP_UNPROCESSABLE_ENTITY = 422
 
const HTTP_UNSUPPORTED_MEDIA_TYPE = 415
 
const HTTP_UPGRADE_REQUIRED = 426
 
const HTTP_USE_PROXY = 305
 
const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506
 
const HTTP_VERSION_NOT_SUPPORTED = 505
 
- Static Public Attributes inherited from Symfony\Component\HttpFoundation\Response
static $statusTexts
 
- Protected Member Functions inherited from Symfony\Component\HttpFoundation\Response
 ensureIEOverSSLCompatibility (Request $request)
 
 ensureIEOverSSLCompatibility (Request $request)
 

Detailed Description

BinaryFileResponse represents an HTTP response delivering a file.

Author
Niklas Fiekas nikla.nosp@m.s.fi.nosp@m.ekas@.nosp@m.tu-c.nosp@m.laust.nosp@m.hal..nosp@m.de
stealth35 steal.nosp@m.th35.nosp@m.-php@.nosp@m.live.nosp@m..fr
Igor Wiedler igor@.nosp@m.wied.nosp@m.ler.c.nosp@m.h
Jordan Alliot jorda.nosp@m.n.al.nosp@m.liot@.nosp@m.gmai.nosp@m.l.com
Sergey Linnik linni.nosp@m.ksa@.nosp@m.gmail.nosp@m..com

Definition at line 26 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::__construct (   $file,
  $status = 200,
  $headers = array(),
  $public = true,
  $contentDisposition = null,
  $autoEtag = false,
  $autoLastModified = true 
)

Constructor.

Parameters
\SplFileInfo | string$fileThe file to stream
int$statusThe response status code
array$headersAn array of response headers
bool$publicFiles are public by default
null | string$contentDispositionThe type of Content-Disposition to set automatically with the filename
bool$autoEtagWhether the ETag header should be automatically set
bool$autoLastModifiedWhether the Last-Modified header should be automatically set

Definition at line 52 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, Symfony\Component\HttpFoundation\Response\$headers, Symfony\Component\HttpFoundation\BinaryFileResponse\setFile(), and Symfony\Component\HttpFoundation\Response\setPublic().

◆ __construct() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::__construct (   $file,
int  $status = 200,
array  $headers = [],
bool  $public = true,
string  $contentDisposition = null,
bool  $autoEtag = false,
bool  $autoLastModified = true 
)
Parameters
\SplFileInfo | string$fileThe file to stream
int$statusThe response status code
array$headersAn array of response headers
bool$publicFiles are public by default
string | null$contentDispositionThe type of Content-Disposition to set automatically with the filename
bool$autoEtagWhether the ETag header should be automatically set
bool$autoLastModifiedWhether the Last-Modified header should be automatically set

Definition at line 50 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, Symfony\Component\HttpFoundation\Response\$headers, Symfony\Component\HttpFoundation\BinaryFileResponse\setFile(), and Symfony\Component\HttpFoundation\Response\setPublic().

Member Function Documentation

◆ create() [1/2]

static Symfony\Component\HttpFoundation\BinaryFileResponse::create (   $file = null,
  $status = 200,
  $headers = [],
  $public = true,
  $contentDisposition = null,
  $autoEtag = false,
  $autoLastModified = true 
)
static
Parameters
\SplFileInfo | string$fileThe file to stream
int$statusThe response status code
array$headersAn array of response headers
bool$publicFiles are public by default
string | null$contentDispositionThe type of Content-Disposition to set automatically with the filename
bool$autoEtagWhether the ETag header should be automatically set
bool$autoLastModifiedWhether the Last-Modified header should be automatically set
Returns
static

Definition at line 72 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, and Symfony\Component\HttpFoundation\Response\$headers.

◆ create() [2/2]

static Symfony\Component\HttpFoundation\BinaryFileResponse::create (   $file = null,
  $status = 200,
  $headers = array(),
  $public = true,
  $contentDisposition = null,
  $autoEtag = false,
  $autoLastModified = true 
)
static
Parameters
\SplFileInfo | string$fileThe file to stream
int$statusThe response status code
array$headersAn array of response headers
bool$publicFiles are public by default
null | string$contentDispositionThe type of Content-Disposition to set automatically with the filename
bool$autoEtagWhether the ETag header should be automatically set
bool$autoLastModifiedWhether the Last-Modified header should be automatically set
Returns
static

Definition at line 74 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, and Symfony\Component\HttpFoundation\Response\$headers.

Referenced by Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testAcceptRangeNotOverriden(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testAcceptRangeOnUnsafeMethods(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testConstruction(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testFullFileRequests(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testInvalidRequests(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testRangeRequestsWithoutLastModifiedDate(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testRequests(), Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testRequestsWithoutEtag(), and Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testXSendfile().

◆ deleteFileAfterSend() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::deleteFileAfterSend (   $shouldDelete)

If this is set to true, the file will be unlinked after the request is send Note: If the X-Sendfile header is used, the deleteFileAfterSend setting will not be used.

Parameters
bool$shouldDelete
Returns
$this

Definition at line 358 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

Referenced by Symfony\Component\HttpFoundation\BinaryFileResponse\deleteFileAfterSend(), and Symfony\Component\HttpFoundation\BinaryFileResponse\sendContent().

◆ deleteFileAfterSend() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::deleteFileAfterSend (   $shouldDelete = true)

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.

Parameters
bool$shouldDelete
Returns
$this

Definition at line 356 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\deleteFileAfterSend().

◆ getContent() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::getContent ( )

{Gets the current response content.

Returns
string Content
}

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 335 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ getContent() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::getContent ( )

{Gets the current response content.

Returns
string Content
}

Returns
false

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 337 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ getFile() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::getFile ( )

Gets the file.

Returns
File The file to stream

Definition at line 125 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file.

◆ getFile() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::getFile ( )

Gets the file.

Returns
File The file to stream

Definition at line 127 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file.

◆ prepare() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::prepare ( Request  $request)

{Prepares the Response before it is sent to the client.This method tweaks the Response to ensure that it is compliant with RFC 2616. Most of the changes are based on the Request that is "associated" with this Response.

Parameters
Request$requestA Request instance
Returns
$this
}

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 188 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\ensureIEOverSSLCompatibility(), Symfony\Component\HttpFoundation\Request\get(), Symfony\Component\HttpFoundation\Request\isMethodSafe(), Symfony\Component\HttpFoundation\Response\setProtocolVersion(), Symfony\Component\HttpFoundation\Response\setStatusCode(), and Symfony\Component\HttpFoundation\HeaderUtils\split().

◆ prepare() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::prepare ( Request  $request)

{Prepares the Response before it is sent to the client.This method tweaks the Response to ensure that it is compliant with RFC 2616. Most of the changes are based on the Request that is "associated" with this Response.

Parameters
Request$requestA Request instance
Returns
$this
}

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 190 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\ensureIEOverSSLCompatibility(), Symfony\Component\HttpFoundation\Request\get(), Symfony\Component\HttpFoundation\Request\isMethodSafe(), Symfony\Component\HttpFoundation\Response\setProtocolVersion(), and Symfony\Component\HttpFoundation\Response\setStatusCode().

◆ sendContent() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::sendContent ( )

Sends the file.

{Sends content for the current web response.

Returns
$this
}

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 293 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, Symfony\Component\HttpFoundation\BinaryFileResponse\deleteFileAfterSend(), and Symfony\Component\HttpFoundation\Response\isSuccessful().

◆ sendContent() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::sendContent ( )

Sends the file.

{Sends content for the current web response.

Returns
$this
}

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 295 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, Symfony\Component\HttpFoundation\BinaryFileResponse\deleteFileAfterSend(), and Symfony\Component\HttpFoundation\Response\isSuccessful().

◆ setAutoEtag() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setAutoEtag ( )

Automatically sets the ETag header according to the checksum of the file.

Definition at line 143 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\setEtag().

◆ setAutoEtag() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setAutoEtag ( )

Automatically sets the ETag header according to the checksum of the file.

Definition at line 145 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\setEtag().

Referenced by Symfony\Component\HttpFoundation\BinaryFileResponse\setFile().

◆ setAutoLastModified() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setAutoLastModified ( )

Automatically sets the Last-Modified header according the file modification date.

Definition at line 133 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\setLastModified().

◆ setAutoLastModified() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setAutoLastModified ( )

Automatically sets the Last-Modified header according the file modification date.

Definition at line 135 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\setLastModified().

Referenced by Symfony\Component\HttpFoundation\BinaryFileResponse\setFile().

◆ setContent() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setContent (   $content)

{Sets the response content.Valid types are strings, numbers, null, and objects that implement a __toString() method.

Parameters
mixed$contentContent that can be cast to string
Returns
$this
Exceptions
}

Exceptions

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 323 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\$content.

◆ setContent() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setContent (   $content)

{Sets the response content.Valid types are strings, numbers, null, and objects that implement a __toString() method.

Parameters
mixed$contentContent that can be cast to string
Returns
$this
Exceptions
}

Exceptions

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 325 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\Response\$content.

◆ setContentDisposition() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setContentDisposition (   $disposition,
  $filename = '',
  $filenameFallback = '' 
)

Sets the Content-Disposition header with the given filename.

Parameters
string$dispositionResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
string$filenameOptionally use this UTF-8 encoded filename instead of the real name of the file
string$filenameFallbackA fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
Returns
$this

Definition at line 159 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ setContentDisposition() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setContentDisposition (   $disposition,
  $filename = '',
  $filenameFallback = '' 
)

Sets the Content-Disposition header with the given filename.

Parameters
string$dispositionResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
string$filenameOptionally use this filename instead of the real name of the file
string$filenameFallbackA fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
Returns
$this

Definition at line 161 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

Referenced by Symfony\Component\HttpFoundation\BinaryFileResponse\setFile().

◆ setFile() [1/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setFile (   $file,
  $contentDisposition = null,
  $autoEtag = false,
  $autoLastModified = true 
)

Sets the file to stream.

Parameters
\SplFileInfo | string$fileThe file to stream
string$contentDisposition
bool$autoEtag
bool$autoLastModified
Returns
$this
Exceptions
FileException

Definition at line 89 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, Symfony\Component\HttpFoundation\BinaryFileResponse\setAutoEtag(), Symfony\Component\HttpFoundation\BinaryFileResponse\setAutoLastModified(), and Symfony\Component\HttpFoundation\BinaryFileResponse\setContentDisposition().

◆ setFile() [2/2]

Symfony\Component\HttpFoundation\BinaryFileResponse::setFile (   $file,
  $contentDisposition = null,
  $autoEtag = false,
  $autoLastModified = true 
)

Sets the file to stream.

Parameters
\SplFileInfo | string$fileThe file to stream
string$contentDisposition
bool$autoEtag
bool$autoLastModified
Returns
$this
Exceptions
FileException

Definition at line 91 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

References Symfony\Component\HttpFoundation\BinaryFileResponse\$file, Symfony\Component\HttpFoundation\BinaryFileResponse\setAutoEtag(), Symfony\Component\HttpFoundation\BinaryFileResponse\setAutoLastModified(), and Symfony\Component\HttpFoundation\BinaryFileResponse\setContentDisposition().

Referenced by Symfony\Component\HttpFoundation\BinaryFileResponse\__construct().

◆ trustXSendfileTypeHeader() [1/2]

static Symfony\Component\HttpFoundation\BinaryFileResponse::trustXSendfileTypeHeader ( )
static

Trust X-Sendfile-Type header.

Definition at line 343 of file vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ trustXSendfileTypeHeader() [2/2]

static Symfony\Component\HttpFoundation\BinaryFileResponse::trustXSendfileTypeHeader ( )
static

Trust X-Sendfile-Type header.

Definition at line 345 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

Referenced by Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testXAccelMapping(), and Symfony\Component\HttpFoundation\Tests\BinaryFileResponseTest\testXSendfile().

Field Documentation

◆ $deleteFileAfterSend

Symfony\Component\HttpFoundation\BinaryFileResponse::$deleteFileAfterSend = false
protected

Definition at line 39 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ $file

File Symfony\Component\HttpFoundation\BinaryFileResponse::$file
protected

Definition at line 36 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

Referenced by Symfony\Component\HttpFoundation\BinaryFileResponse\__construct(), Symfony\Component\HttpFoundation\BinaryFileResponse\create(), Symfony\Component\HttpFoundation\BinaryFileResponse\getFile(), Symfony\Component\HttpFoundation\BinaryFileResponse\sendContent(), and Symfony\Component\HttpFoundation\BinaryFileResponse\setFile().

◆ $maxlen

Symfony\Component\HttpFoundation\BinaryFileResponse::$maxlen = -1
protected

Definition at line 38 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ $offset

Symfony\Component\HttpFoundation\BinaryFileResponse::$offset = 0
protected

Definition at line 37 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

◆ $trustXSendfileTypeHeader

static Symfony\Component\HttpFoundation\BinaryFileResponse::$trustXSendfileTypeHeader = false
staticprotected

Definition at line 28 of file lib/vendor/symfony/http-foundation/BinaryFileResponse.php.

The documentation for this class was generated from the following file: