Inheritance diagram for Response:

Public Member Functions
	__construct ($body= '', $status=200, $headers=[])

	isSuccess ()

	finish ($content_renderer)

	output ()

	sendHeader ($header, $replace=FALSE, $status=NULL)

	reason ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

Detailed Description

Response class for the rest api

Constructor & Destructor Documentation

Constructor, sets vital information if provided.

Parameters

String	$body	Body contents of the response, optional, defaults to empty string
int	$status	HTTP status code, optional, defaults to 200
Array	$headers	HTTP headers, optional, defaults to no headers

finish ( $content_renderer )

Finishes the response with the given response renderer.

Parameters

Renderer\DefaultRenderer $content_renderer Used response renderer, only applied if body is not a callable closure

isSuccess ( )

Detects whether the response status is of success type (HTTP status 2xx)

offsetExists ( $offset )

offsetGet ( $offset )

Parameters

$offset

offsetUnset ( $offset )

output ( )

Sends the response.

reason ( )

Returns the reason phrase of this response according to RFC2616.

Internally used function to actually send headers

Parameters

string	the HTTP header
bool	optional; TRUE if previously sent header should be replaced - FALSE otherwise (default)
integer	optional; the HTTP response code

$body

$headers

$status

The documentation for this class was generated from the following file: