Response Class Reference

Inheritance diagram for Response:

Collaboration 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)

Data Fields
	$body
	$status
	$headers

Detailed Description

Response class for the rest api

Author

mlunz.nosp@m.ena@.nosp@m.uos.d.nosp@m.e @license GPL 2 or later

Since

Stud.IP 3.0

Constructor & Destructor Documentation

__construct()

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

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

Member Function Documentation

finish()

finish

(

$content_renderer

)

Finishes the response with the given response renderer.

Parameters

RESTAPI\Renderer\DefaultRenderer

$content_renderer

Used response renderer, only applied if body is not a callable closure

isSuccess()

isSuccess

(

)

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

Returns

bool True if status is of success type, false otherwise

offsetExists()

offsetExists

(

$offset

)

offsetGet()

offsetGet

(

$offset

)

offsetSet()

offsetSet	(		$offset,
			$value
	)

offsetUnset()

offsetUnset

(

$offset

)

output()

output

(

)

Sends the response.

reason()

reason

(

)

Returns the reason phrase of this response according to RFC2616.

Returns

string the reason phrase for this response's status

sendHeader()

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

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

Returns

void

Field Documentation

$body

$body

$headers

$headers

$status

$status

---

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

• lib/classes/restapi/Response.php