Class Symfony\Component\HttpFoundation\BinaryFileResponse

`extends`	`Response`

BinaryFileResponse represents an HTTP response delivering a file.

Symfony\Component\HttpFoundation\Response
- Symfony\Component\HttpFoundation\BinaryFileResponse

Methods


					
	public

__construct(
	SplFileInfo|string $file,
	int $status = 200,
	array $headers = [],
	bool $public = true,
	string|null $contentDisposition = null,
	bool $autoEtag = false,
	bool $autoLastModified = true,
)

Parameters

`$file`	The file to stream
`$status`	The response status code (200 "OK" by default)
`$headers`	An array of response headers
`$public`	Files are public by default
`$contentDisposition`	The type of Content-Disposition to set automatically with the filename
`$autoEtag`	Whether the ETag header should be automatically set
`$autoLastModified`	Whether the Last-Modified header should be automatically set

Overrides

Symfony\Component\HttpFoundation\Response::__construct()


					
	public

setFile(
	SplFileInfo|string $file,
	string $contentDisposition = null,
	bool $autoEtag = false,
	bool $autoLastModified = true,
): $this

Sets the file to stream.

Throws

Symfony\Component\HttpFoundation\File\Exception\FileException


					
	public

getFile(): File

Gets the file.


					
	public

setChunkSize(int $chunkSize): $this

Sets the response stream chunk size.


					
	public

setAutoLastModified(): $this

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


					
	public

setAutoEtag(): $this

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


					
	public

setContentDisposition(string $disposition, string $filename = '', string $filenameFallback = ''): $this

Sets the Content-Disposition header with the given filename.

Parameters

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


					
	public

prepare(Request $request): static

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.

Overrides

Symfony\Component\HttpFoundation\Response::prepare()


					
	private

hasValidIfRangeHeader(?string $header): bool


					
	public

sendContent(): static

Sends content for the current web response.

Overrides

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


					
	public

setContent(?string $content): static

Sets the response content.

Throws

LogicException

when the content is not null

Overrides

Symfony\Component\HttpFoundation\Response::setContent()


					
	public

getContent(): string|false

Gets the current response content.

Overrides

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


					
	public
					static

trustXSendfileTypeHeader(): void

Trust X-Sendfile-Type header.


					
	public

deleteFileAfterSend(bool $shouldDelete = true): $this

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…

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.

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

Methods inherited from Symfony\Component\HttpFoundation\Response

__toString(), __clone(), sendHeaders(), send(), setProtocolVersion(), getProtocolVersion(), setStatusCode(), getStatusCode(), setCharset(), getCharset(), isCacheable(), isFresh(), isValidateable(), setPrivate(), setPublic(), setImmutable(), isImmutable(), mustRevalidate(), getDate(), setDate(), getAge(), expire(), getExpires(), setExpires(), getMaxAge(), setMaxAge(), setStaleIfError(), setStaleWhileRevalidate(), setSharedMaxAge(), getTtl(), setTtl(), setClientTtl(), getLastModified(), setLastModified(), getEtag(), setEtag(), setCache(), setNotModified(), hasVary(), getVary(), setVary(), isNotModified(), isInvalid(), isInformational(), isSuccessful(), isRedirection(), isClientError(), isServerError(), isOk(), isForbidden(), isNotFound(), isRedirect(), isEmpty(), closeOutputBuffers(), setContentSafe(), ensureIEOverSSLCompatibility()

Constants inherited from Symfony\Component\HttpFoundation\Response
HTTP_CONTINUE, HTTP_SWITCHING_PROTOCOLS, HTTP_PROCESSING, HTTP_EARLY_HINTS, HTTP_OK, HTTP_CREATED, HTTP_ACCEPTED, HTTP_NON_AUTHORITATIVE_INFORMATION, HTTP_NO_CONTENT, HTTP_RESET_CONTENT, HTTP_PARTIAL_CONTENT, HTTP_MULTI_STATUS, HTTP_ALREADY_REPORTED, HTTP_IM_USED, HTTP_MULTIPLE_CHOICES, HTTP_MOVED_PERMANENTLY, HTTP_FOUND, HTTP_SEE_OTHER, HTTP_NOT_MODIFIED, HTTP_USE_PROXY, HTTP_RESERVED, HTTP_TEMPORARY_REDIRECT, HTTP_PERMANENTLY_REDIRECT, HTTP_BAD_REQUEST, HTTP_UNAUTHORIZED, HTTP_PAYMENT_REQUIRED, HTTP_FORBIDDEN, HTTP_NOT_FOUND, HTTP_METHOD_NOT_ALLOWED, HTTP_NOT_ACCEPTABLE, HTTP_PROXY_AUTHENTICATION_REQUIRED, HTTP_REQUEST_TIMEOUT, HTTP_CONFLICT, HTTP_GONE, HTTP_LENGTH_REQUIRED, HTTP_PRECONDITION_FAILED, HTTP_REQUEST_ENTITY_TOO_LARGE, HTTP_REQUEST_URI_TOO_LONG, HTTP_UNSUPPORTED_MEDIA_TYPE, HTTP_REQUESTED_RANGE_NOT_SATISFIABLE, HTTP_EXPECTATION_FAILED, HTTP_I_AM_A_TEAPOT, HTTP_MISDIRECTED_REQUEST, HTTP_UNPROCESSABLE_ENTITY, HTTP_LOCKED, HTTP_FAILED_DEPENDENCY, HTTP_TOO_EARLY, HTTP_UPGRADE_REQUIRED, HTTP_PRECONDITION_REQUIRED, HTTP_TOO_MANY_REQUESTS, HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE, HTTP_UNAVAILABLE_FOR_LEGAL_REASONS, HTTP_INTERNAL_SERVER_ERROR, HTTP_NOT_IMPLEMENTED, HTTP_BAD_GATEWAY, HTTP_SERVICE_UNAVAILABLE, HTTP_GATEWAY_TIMEOUT, HTTP_VERSION_NOT_SUPPORTED, HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL, HTTP_INSUFFICIENT_STORAGE, HTTP_LOOP_DETECTED, HTTP_NOT_EXTENDED, HTTP_NETWORK_AUTHENTICATION_REQUIRED, HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES

Constants inherited from Symfony\Component\HttpFoundation\Response

HTTP_CONTINUE, HTTP_SWITCHING_PROTOCOLS, HTTP_PROCESSING, HTTP_EARLY_HINTS, HTTP_OK, HTTP_CREATED, HTTP_ACCEPTED, HTTP_NON_AUTHORITATIVE_INFORMATION, HTTP_NO_CONTENT, HTTP_RESET_CONTENT, HTTP_PARTIAL_CONTENT, HTTP_MULTI_STATUS, HTTP_ALREADY_REPORTED, HTTP_IM_USED, HTTP_MULTIPLE_CHOICES, HTTP_MOVED_PERMANENTLY, HTTP_FOUND, HTTP_SEE_OTHER, HTTP_NOT_MODIFIED, HTTP_USE_PROXY, HTTP_RESERVED, HTTP_TEMPORARY_REDIRECT, HTTP_PERMANENTLY_REDIRECT, HTTP_BAD_REQUEST, HTTP_UNAUTHORIZED, HTTP_PAYMENT_REQUIRED, HTTP_FORBIDDEN, HTTP_NOT_FOUND, HTTP_METHOD_NOT_ALLOWED, HTTP_NOT_ACCEPTABLE, HTTP_PROXY_AUTHENTICATION_REQUIRED, HTTP_REQUEST_TIMEOUT, HTTP_CONFLICT, HTTP_GONE, HTTP_LENGTH_REQUIRED, HTTP_PRECONDITION_FAILED, HTTP_REQUEST_ENTITY_TOO_LARGE, HTTP_REQUEST_URI_TOO_LONG, HTTP_UNSUPPORTED_MEDIA_TYPE, HTTP_REQUESTED_RANGE_NOT_SATISFIABLE, HTTP_EXPECTATION_FAILED, HTTP_I_AM_A_TEAPOT, HTTP_MISDIRECTED_REQUEST, HTTP_UNPROCESSABLE_ENTITY, HTTP_LOCKED, HTTP_FAILED_DEPENDENCY, HTTP_TOO_EARLY, HTTP_UPGRADE_REQUIRED, HTTP_PRECONDITION_REQUIRED, HTTP_TOO_MANY_REQUESTS, HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE, HTTP_UNAVAILABLE_FOR_LEGAL_REASONS, HTTP_INTERNAL_SERVER_ERROR, HTTP_NOT_IMPLEMENTED, HTTP_BAD_GATEWAY, HTTP_SERVICE_UNAVAILABLE, HTTP_GATEWAY_TIMEOUT, HTTP_VERSION_NOT_SUPPORTED, HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL, HTTP_INSUFFICIENT_STORAGE, HTTP_LOOP_DETECTED, HTTP_NOT_EXTENDED, HTTP_NETWORK_AUTHENTICATION_REQUIRED, HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES

Properties
`protected static`		`$trustXSendfileTypeHeader = false`	#
`protected`	`File`	`$file`	#
`protected`		`$offset = 0`	#
`protected`		`$maxlen = -1`	#
`protected`		`$deleteFileAfterSend = false`	#
`protected`		`$chunkSize = 16 * 1024`	#

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

Namespaces

Classes

Class Symfony\Component\HttpFoundation\BinaryFileResponse

Parameters

Overrides

Throws

Parameters

Overrides

Overrides

Throws

Overrides

Overrides