Orpheus

HttpResponse extends OutputResponse
in package

Table of Contents

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 ?
$fileName  : string|null
The file name shared to the client
$lastModifiedDate  : DateTime|null
Client cache max age in seconds

Methods

__construct()  : mixed
Constructor
__toString()  : string
Get this response as string
collectFrom()  : void
generateFromException()  : static
Generate HtmlResponse from Exception
generateFromUserException()  : static
Generate HtmlResponse 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
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
sendHeaders()  : void

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

$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

Methods

__construct()

Constructor

public __construct([string|null $body = null ][, string|null $contentType = null ][, bool $download = false ][, string|null $fileName = null ]) : mixed
Parameters
$body : string|null = null
$contentType : string|null = null
$download : bool = false
$fileName : string|null = null

__toString()

Get this response as string

public __toString() : string
Return values
string

collectFrom()

public collectFrom(string $layout[, array<string|int, mixed> $values = [] ]) : void
Parameters
$layout : string
$values : array<string|int, mixed> = []

generateFromException()

Generate HtmlResponse from Exception

public static generateFromException(Exception $exception[, array<string|int, mixed> $values = [] ]) : static
Parameters
$exception : Exception
$values : array<string|int, mixed> = []
Return values
static

generateFromUserException()

Generate HtmlResponse from UserException

public static generateFromUserException(UserException $exception[, array<string|int, mixed> $values = [] ]) : static
Parameters
$exception : UserException
$values : array<string|int, mixed> = []
Return values
static

getBody()

Get the body

public getBody() : string
Return values
string

getCacheMaxAge()

public getCacheMaxAge() : int
Return values
int

getCode()

Get the code

public getCode() : int|null
Return values
int|null

getContentLength()

public getContentLength() : int
Return values
int

getContentType()

public getContentType() : string|null
Return values
string|null

getControllerOutput()

Get the controller output

public getControllerOutput() : string|null
Return values
string|null

getFileName()

public getFileName() : string
Return values
string

getHttpDateFormat()

public getHttpDateFormat() : string
Return values
string

getLastModifiedDate()

public getLastModifiedDate() : DateTime
Return values
DateTime

isDownload()

public isDownload() : bool
Return values
bool

run()

Process response to client

public run() : bool
Return values
bool

setCacheMaxAge()

public setCacheMaxAge(int $cacheMaxAge) : void
Parameters
$cacheMaxAge : int

setContentLength()

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
$this

getContentDisposition()

Get content disposition header value

protected getContentDisposition() : string
Return values
string 

							

							
						

					

					
					
				
				

			

			

				
				

					On this page
					
					
				

			
			

		

		

			

				

					
Search results