Orpheus

JsonHttpResponse extends HttpResponse

in package

• orpheus

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

$data  : array<string|int, mixed>|JsonSerializable|stdClass|null

The data of the JSON response

$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

collect()  : void

collectFrom()  : void

generateFromException()  : JsonHttpResponse

Generate HtmlResponse from Exception

generateFromUserException()  : JsonHttpResponse

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

getData()  : array<string|int, mixed>|stdClass|JsonSerializable|null

Get the data

getFileName()  : string

getHttpDateFormat()  : string

getLastModifiedDate()  : DateTime

isDownload()  : bool

process()  : void

Process the response

render()  : JsonHttpResponse

Render the given data

returnData()  : JsonHttpResponse

Get a response with the given $data

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

setData()  : JsonHttpResponse

Set the data

setDownload()  : void

setFileName()  : void

setLastModifiedDate()  : $this

getContentDisposition()  : string

Get content disposition header value

sendHeaders()  : void