FileHttpResponse
extends HttpResponse
in package
Table of Contents
Constants
- DEFAULT_MIMETYPE = 'text/plain'
- Default mimetype
Properties
- $body : string|null
- The HTML body of the response
- $cacheMaxAge : int|null
- Client cache max age in seconds
- $code : int|null
- The HTTP response code
- $contentLength : int|null
- $contentType : string|null
- $controllerOutput : string|null
- The output of the controller when running it
- $download : bool
- Is the file downloaded ? Or displayed ?
- $extensionMimeTypes : array<string|int, mixed>
- Registered mimetype for extension
- $fileName : string|null
- The file name shared to the client
- $lastModifiedDate : DateTime|null
- Client cache max age in seconds
- $resource : resource|null
- The resource of file
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Get this response as string
- collectFrom() : void
- generateFromException() : static
- Generate OutputResponse from Exception
- generateFromUserException() : static
- Generate OutputResponse from UserException
- getBody() : string
- Get the body
- getCacheMaxAge() : int
- getCode() : int|null
- Get the code
- getContentLength() : int
- getContentType() : string|null
- getControllerOutput() : string|null
- Get the controller output
- getFileName() : string
- getHttpDateFormat() : string
- getLastModifiedDate() : DateTime
- getMimeType() : string
- Get mimetype
- getSize() : int
- isDownload() : bool
- process() : void
- Process the response
- run() : bool
- Process response to client
- setBody() : HttpResponse
- Set the body
- setCacheMaxAge() : void
- setCode() : HttpResponse
- Set the code
- setContentLength() : void
- setContentType() : void
- setControllerOutput() : void
- Set the controller output
- setDownload() : void
- setFileName() : void
- setLastModifiedDate() : $this
- getContentDisposition() : string
- Get content disposition header value
- getMimetypeFromExtension() : string
- Get mimetype from extension
- sendHeaders() : void
- setExtensionMimetype() : void
- Set extension's mimetype
Constants
DEFAULT_MIMETYPE
Default mimetype
public
string
DEFAULT_MIMETYPE
= 'text/plain'
Properties
$body
The HTML body of the response
protected
string|null
$body
= null
$cacheMaxAge
Client cache max age in seconds
protected
int|null
$cacheMaxAge
= null
$code
The HTTP response code
protected
int|null
$code
= null
$contentLength
protected
int|null
$contentLength
= null
The content length to send to client
$contentType
protected
string|null
$contentType
= null
The content type to send to client
$controllerOutput
The output of the controller when running it
protected
string|null
$controllerOutput
= null
$download
Is the file downloaded ? Or displayed ?
protected
bool
$download
= false
$extensionMimeTypes
Registered mimetype for extension
protected
static array<string|int, mixed>
$extensionMimeTypes
= ['css' => 'text/css', 'js' => 'application/javascript', 'pdf' => 'application/pdf']
$fileName
The file name shared to the client
protected
string|null
$fileName
= null
$lastModifiedDate
Client cache max age in seconds
protected
DateTime|null
$lastModifiedDate
= null
$resource
The resource of file
protected
resource|null
$resource
Methods
__construct()
Constructor
public
__construct(resource|null $resource, string $fileName[, bool $download = true ][, int $cacheMaxAge = 0 ]) : mixed
Parameters
- $resource : resource|null
-
resource to get read while rendering, pass null and override run() to get it by your own way
- $fileName : string
- $download : bool = true
- $cacheMaxAge : int = 0
__toString()
Get this response as string
public
__toString() : string
Return values
stringcollectFrom()
public
collectFrom(string $layout[, array<string|int, mixed> $values = [] ]) : void
Parameters
- $layout : string
- $values : array<string|int, mixed> = []
generateFromException()
Generate OutputResponse from Exception
public
static generateFromException(Throwable $exception[, array<string|int, mixed> $values = [] ]) : static
Parameters
- $exception : Throwable
- $values : array<string|int, mixed> = []
Return values
staticgenerateFromUserException()
Generate OutputResponse from UserException
public
static generateFromUserException(UserException $exception[, array<string|int, mixed> $values = [] ]) : static
Parameters
- $exception : UserException
- $values : array<string|int, mixed> = []
Return values
staticgetBody()
Get the body
public
getBody() : string
Return values
stringgetCacheMaxAge()
public
getCacheMaxAge() : int
Return values
intgetCode()
Get the code
public
getCode() : int|null
Return values
int|nullgetContentLength()
public
getContentLength() : int
Return values
intgetContentType()
public
getContentType() : string|null
Return values
string|nullgetControllerOutput()
Get the controller output
public
getControllerOutput() : string|null
Return values
string|nullgetFileName()
public
getFileName() : string
Return values
stringgetHttpDateFormat()
public
getHttpDateFormat() : string
Return values
stringgetLastModifiedDate()
public
getLastModifiedDate() : DateTime
Return values
DateTimegetMimeType()
Get mimetype
public
getMimeType() : string
Return values
stringgetSize()
public
getSize() : int
Return values
intisDownload()
public
isDownload() : bool
Return values
boolprocess()
Process the response
public
process() : void
run()
Process response to client
public
run() : bool
Return values
boolsetBody()
Set the body
public
setBody(string|null $body) : HttpResponse
Parameters
- $body : string|null
Return values
HttpResponsesetCacheMaxAge()
public
setCacheMaxAge(int $cacheMaxAge) : void
Parameters
- $cacheMaxAge : int
setCode()
Set the code
public
setCode(int $code) : HttpResponse
Parameters
- $code : int
Return values
HttpResponsesetContentLength()
public
setContentLength(int $contentLength) : void
Parameters
- $contentLength : int
setContentType()
public
setContentType(string $contentType) : void
Parameters
- $contentType : string
setControllerOutput()
Set the controller output
public
setControllerOutput(string $controllerOutput) : void
Parameters
- $controllerOutput : string
setDownload()
public
setDownload(bool $download) : void
Parameters
- $download : bool
setFileName()
public
setFileName(string $fileName) : void
Parameters
- $fileName : string
setLastModifiedDate()
public
setLastModifiedDate(DateTime|int $lastModifiedDate) : $this
Parameters
- $lastModifiedDate : DateTime|int
-
DateTime or timestamp
Return values
$thisgetContentDisposition()
Get content disposition header value
protected
getContentDisposition() : string
Return values
stringgetMimetypeFromExtension()
Get mimetype from extension
protected
static getMimetypeFromExtension(string $extension) : string
Parameters
- $extension : string
Return values
stringsendHeaders()
protected
sendHeaders() : void
setExtensionMimetype()
Set extension's mimetype
protected
static setExtensionMimetype(string $extension, string $mimetype) : void
Parameters
- $extension : string
- $mimetype : string