Class ResponseHandlerComponent

Response handler component

Handle json/xml response preparing data to serialize and setting up the right View class to use. Help to set headers for the client too.

Object

Extended by

ResponseHandlerComponent

Located at controllers/components/response_handler.php

Methods summary

`public`	# `initialize( Controller $controller, array $settings = array() )` Initialize self::type from $settings or from extension or from request ACCEPT header Initialize self::type from $settings or from extension or from request ACCEPT header Parameters `$controller` `$settings`
`public`	# `startup( Controller $controller )` The startup Component callback The startup Component callback Parameters `$controller`
`public`	# `beforeRender( Controller $controller )` The beforeRender Component callback If self::type was set and is supported (self::typesHandled) set content type header, the right View to use and data for view. The beforeRender Component callback If self::type was set and is supported (self::typesHandled) set content type header, the right View to use and data for view. Parameters `$controller`
`public string\|null`	# `getType( )` Return the response type set Return the response type set Returns string\|null
`public`	# `setType( string $type )` Set the response type that will be used in self::beforeRender() Set the response type that will be used in self::beforeRender() Parameters `$type`
`public`	# `sendStatus( integer $status )` Send status code to client Send status code to client Parameters `$status` the http status code as 200, 404, 500, etc...
`public`	# `sendHeader( string $name, string $value = null )` Send header to client. Send header to client. Parameters `$name` the header name `$value` the header value
`private`	# `setupXml( )` setup specific data for Xml View setup specific data for Xml View

Properties summary

`public array`	`$components` Other Components used Other Components used	# `array('RequestHandler')`
`public Controller`	`$controller` The Controller The Controller	# `null`
`public boolean`	`$enabled` Determines whether or not callbacks will be fired on this component i.e. self::initialize(), self::startup(), self::beforeRender() Determines whether or not callbacks will be fired on this component i.e. self::initialize(), self::startup(), self::beforeRender()	# `true`
`protected string\|null`	`$type` The response type as 'json', 'xml' The response type as 'json', 'xml'	# `null`
`private array`	`$typesHandled` The types that are automatically handled. For these types the right content type and the right View class are set. Moreover all view variables found in '_serialize' key will be prepared to be serialized in the right View The types that are automatically handled. For these types the right content type and the right View class are set. Moreover all view variables found in '_serialize' key will be prepared to be serialized in the right View	# `array('json', 'xml')`
`public string`	`$xmlFormat` Xml format (tags or attributes) Xml format (tags or attributes)	# `'tags'`