Class BinaryFileResponse

BinaryFileResponse represents an HTTP response delivering a file.

Symfony\Component\HttpFoundation\Response

Symfony\Component\HttpFoundation\BinaryFileResponse

Namespace: Symfony\Component\HttpFoundation
Author: Niklas Fiekas <niklas.fiekas@tu-clausthal.de>
Author: stealth35 <stealth35-php@live.fr>
Author: Igor Wiedler <igor@wiedler.ch>
Author: Jordan Alliot <jordan.alliot@gmail.com>
Author: Sergey Linnik <linniksa@gmail.com>
Located at laravel/vendor/Symfony/Component/HttpFoundation/BinaryFileResponse.php

Methods summary
`public`	# `__construct( SplFileInfo\|string $file, integer $status = 200, array $headers = array(), boolean $public = true, null\|string $contentDisposition = null, boolean $autoEtag = false, boolean $autoLastModified = true )` Constructor. Constructor. Parameters `$file` `SplFileInfo\|string` $file The file to stream `$status` `integer` $status The response status code `$headers` `array` $headers An array of response headers `$public` `boolean` $public Files are public by default `$contentDisposition` `null\|string` $contentDisposition The type of Content-Disposition to set automatically with the filename `$autoEtag` `boolean` $autoEtag Whether the ETag header should be automatically set `$autoLastModified` `boolean` $autoLastModified Whether the Last-Modified header should be automatically set Throws `InvalidArgumentException` When the HTTP status code is not valid Overrides `Symfony\Component\HttpFoundation\Response::__construct()`
`public static Symfony\Component\HttpFoundation\Response`	# `create( string $file = null, integer $status = 200, array $headers = array(), mixed $public = true, mixed $contentDisposition = null, mixed $autoEtag = false, mixed $autoLastModified = true )` Factory method for chainability Factory method for chainability Parameters `$file` `string` $content The response content `$status` `integer` $status The response status code `$headers` `array` $headers An array of response headers `$public` `$contentDisposition` `$autoEtag` `$autoLastModified` Returns `Symfony\Component\HttpFoundation\Response` Overrides `Symfony\Component\HttpFoundation\Response::create()`
`public Symfony\Component\HttpFoundation\BinaryFileResponse`	# `setFile( SplFileInfo\|string $file, string $contentDisposition = null, Boolean $autoEtag = false, Boolean $autoLastModified = true )` Sets the file to stream. Sets the file to stream. Parameters `$file` `SplFileInfo\|string` $file The file to stream `$contentDisposition` `string` $contentDisposition `$autoEtag` `Boolean` $autoEtag `$autoLastModified` `Boolean` $autoLastModified Returns `Symfony\Component\HttpFoundation\BinaryFileResponse` Throws `Symfony\Component\HttpFoundation\File\Exception\FileException`
`public Symfony\Component\HttpFoundation\File\File`	# `getFile( )` Gets the file. Gets the file. Returns `Symfony\Component\HttpFoundation\File\File` The file to stream
`public`	# `setAutoLastModified( )` Automatically sets the Last-Modified header according the file modification date. Automatically sets the Last-Modified header according the file modification date.
`public`	# `setAutoEtag( )` Automatically sets the ETag header according to the checksum of the file. Automatically sets the ETag header according to the checksum of the file.
`public Symfony\Component\HttpFoundation\BinaryFileResponse`	# `setContentDisposition( string $disposition, string $filename = '', string $filenameFallback = '' )` Sets the Content-Disposition header with the given filename. Sets the Content-Disposition header with the given filename. Parameters `$disposition` `string` $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT `$filename` `string` $filename Optionally use this filename instead of the real name of the file `$filenameFallback` `string` $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename Returns `Symfony\Component\HttpFoundation\BinaryFileResponse`
`public Symfony\Component\HttpFoundation\Response`	# `prepare( Symfony\Component\HttpFoundation\Request $request )` Prepares the Response before it is sent to the client. Prepares the Response before it is sent to the client. Parameters `$request` `Symfony\Component\HttpFoundation\Request` $request A Request instance Returns `Symfony\Component\HttpFoundation\Response` The current response. Overrides `Symfony\Component\HttpFoundation\Response::prepare()`
`public Symfony\Component\HttpFoundation\Response`	# `sendContent( )` Sends the file. Sends the file. Returns `Symfony\Component\HttpFoundation\Response` Overrides `Symfony\Component\HttpFoundation\Response::sendContent()`
`public Symfony\Component\HttpFoundation\Response`	# `setContent( mixed $content )` Sets the response content. Sets the response content. Parameters `$content` `mixed` $content Returns `Symfony\Component\HttpFoundation\Response` Throws `LogicException` when the content is not null Overrides `Symfony\Component\HttpFoundation\Response::setContent()`
`public false`	# `getContent( )` Gets the current response content. Gets the current response content. Returns `false` Overrides `Symfony\Component\HttpFoundation\Response::getContent()`
`public static`	# `trustXSendfileTypeHeader( )` Trust X-Sendfile-Type header. Trust X-Sendfile-Type header.

Methods inherited from Symfony\Component\HttpFoundation\Response
__clone(), __toString(), expire(), getAge(), getCharset(), getDate(), getEtag(), getExpires(), getLastModified(), getMaxAge(), getProtocolVersion(), getStatusCode(), getTtl(), getVary(), hasVary(), isCacheable(), isClientError(), isEmpty(), isForbidden(), isFresh(), isInformational(), isInvalid(), isNotFound(), isNotModified(), isOk(), isRedirect(), isRedirection(), isServerError(), isSuccessful(), isValidateable(), mustRevalidate(), send(), sendHeaders(), setCache(), setCharset(), setClientTtl(), setDate(), setEtag(), setExpires(), setLastModified(), setMaxAge(), setNotModified(), setPrivate(), setProtocolVersion(), setPublic(), setSharedMaxAge(), setStatusCode(), setTtl(), setVary()

Properties summary
`protected static boolean`	`$trustXSendfileTypeHeader`	`false`	#
`protected mixed`	`$file`		#
`protected mixed`	`$offset`		#
`protected mixed`	`$maxlen`		#

Properties inherited from Symfony\Component\HttpFoundation\Response
`$charset, $content, $headers, $statusCode, $statusText, $statusTexts, $version`

Namespaces

Classes

Interfaces

Class BinaryFileResponse

Parameters

Throws

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides