Response Class. More...

Public Member Functions
	__construct ()
	Constructor.
	reset ()
	Reset the axResponse instance to its initial state.
	getView ()
	Get the view name.
	setView ($view)
	Set view name.
	getViewSection ()
	Get the view section.
	setViewSection ($section)
	set View section
	getFormat ()
	Get view format.
	setFormat ($format)
	Set view format.
	getLayout ()
	Get view layout.
	setLayout ($layout)
	Set view layout.
	enableLayout ($enabled=true)
	Enable of disable layout according to the $enabled parameter.
	layoutState ()
	Tells if the layout is enabled or not.
	getVar ($name)
	Get the given var.
	setVar ($name, $value)
	Set the given var.
	__get ($key)
	__get implementation
	__set ($key, $value)
	__set implementation
	getVars ()
	Get all the registered var.
	add ($collection, $method=self::MERGE_VARS)
	Add or merge a collection to the current registered variables.
	clearVars ()
	Remove all the registered variables.
	setHeader ($field, $value)
	Add an header to the header list.
	setHaders (array $headers)
	Set multiple headers at once.
	setStatus ($http_status)
	Set the HTTP status http://en.wikipedia.org/wiki/List_of_HTTP_status_codes.
	getHeaders ()
	Get the headers list.
	clearHeaders ()
	Clear all registered headers.
	setOutputCallback ($callback)
	Set a callback to be executed on the output buffer before it is sent to the browser.
	getOutputCallback ()
	Get the output callback.
	hasFilter ()
	Tells whenever a filter has been registered or not.
	getFilter ()
	Get the registered filter.
	setFilter (array $filter)
	Set a response variable filter.
	addMessage ($message, $level=self::MESSAGE_WARNING)
	Adds a view message.
	removeMessage ($message)
	getMessages ($level=null)
	Get all view messages, optionnaly filtered by their level.
	clearMessages ()
	Erase all registered messages.
	addStyleSheet ($stylesheet, $type="text/css", $media="screen")
	Add a view style sheet.
	removeStyleSheet ($stylehseet)
	Remove a style sheet (identified by its `href` attribute)
	clearStyleSheets ()
	Erase all registered stylesheets.
	addScript ($script, $type="text/javascript")
	removeScript ($script)
	Remove a script (identified by its `src`)
	clearScripts ()
	Erase all registered scripts.
	setCookie ($name, $value="", $expire=0, $path="", $domain="", $secure=false, $httponly=false)
	PHP setcookie alias.
	setRawCookie ($name, $value="", $expire=0, $path="", $domain="", $secure=false, $httponly=false)
	PHP setrawcookie alias.
Data Fields
const	MERGE_VARS = "merge"
const	ADD_VARS = "add"
const	MESSAGE_NOTICE = "notice"
const	MESSAGE_WARNING = "warning"
const	MESSAGE_ALERT = "alert"
const	HEADER_ACCEPT_RANGE = "Accept-Ranges"
const	HEADER_AGE = "Age"
const	HEADER_ALLOW = "Allow"
const	HEADER_CACHE_CONTROL = "Cache-Control"
const	HEADER_CONNECTION = "Connection"
const	HEADER_CONTENT_ENCODING = "Content-Encoding"
const	HEADER_CONTENT_LANGUAGE = "Content-Language"
const	HEADER_CONTENT_LENGTH = "Content-Length"
const	HEADER_CONTENT_LOCATION = "Content-Location"
const	HEADER_CONTENT_MD5 = "Content-MD5"
const	HEADER_CONTENT_DISPOSITION = "Content-Disposition"
const	HEADER_CONTENT_RANGE = "Content-Range"
const	HEADER_CONTENT_TYPE = "Content-Type"
const	HEADER_DATE = "Date"
const	HEADER_ETAG = "ETag"
const	HEADER_EXPIRES = "Expires"
const	HEADER_LAST_MODIFIED = "Last-Modified"
const	HEADER_LINK = "Link"
const	HEADER_LOCATION = "Location"
const	HEADER_P3P = "P3P"
const	HEADER_PRAGMA = "Pragma"
const	HEADER_PROXY_AUTHENTICATE = "Proxy-Authenticate"
const	HEADER_REFRESH = "Refresh"
const	HEADER_RETRY_AFTER = "Retry-After"
const	HEADER_SERVER = "Server"
const	HEADER_SET_COOKIE = "Set-Cookie"
const	HEADER_STS = "Strict-Transport-Security"
const	HEADER_TRAILER = "Trailer"
const	HEADER_TRANSFER_ENCODING = "Transfer-Encoding"
const	HEADER_VARY = "Vary"
const	HEADER_VIA = "Via"
const	HEADER_WARNING = "Warning"
const	HEADER_WWW_AUTHENTICATE = "WWW-Authenticate"
Protected Member Functions
	_applyFilter ()
	If any, apply the filter on the registered variables.
Protected Attributes
	$_view
	View name.
	$_viewSection
	View section.
	$_viewFormat
	View format.
	$_viewLayout
	Layout name.
	$_layoutEnabled
	Enabled layout flag.
	$_vars
	View variables.
	$_headers
	Response Headers.
	$_outputCallback
	$_filter
	$_filterFlag
	Filter flag.
	$_messages
	View messages.
	$_styleSheets
	$_scripts
	View scripts.

Detailed Description

Response Class.

Todo:: axResponse long description

Author:: Delespierre

Copyright:: Copyright 2010-2011, Benjamin Delespierre (http://bdelespierre.fr)

License:: http://www.gnu.org/licenses/lgpl.html Lesser General Public Licence version 3

Definition at line 17 of file axResponse.class.php.

Constructor & Destructor Documentation

axResponse::__construct ( )

Constructor.

Definition at line 107 of file axResponse.class.php.

Member Function Documentation

axResponse::__get ( $ key )

__get implementation

See also:: axResponse::getVar()

Parameters:

string $key

Returns:: mixed

Definition at line 273 of file axResponse.class.php.

axResponse::__set	(	$	key,
		$	value
	)

__set implementation

See also:: axResponse::setVar()

Parameters:

string	$key
mixed	$value

Returns:: void

Definition at line 285 of file axResponse.class.php.

axResponse::_applyFilter ( ) [protected]

If any, apply the filter on the registered variables.

If the filter fails, all variables will be erased as well as the registered filter to prevent the script to be stuck. A RuntimeException will also be thrown.

Exceptions:

RuntimeException If the filter fails

Returns:: boolan

Definition at line 674 of file axResponse.class.php.

axResponse::add	(	$	collection,
		$	method = `self::MERGE_VARS`
	)

Add or merge a collection to the current registered variables.

Will return false if the $method parameter is unknown.

Parameters:

array	$collection
string	$method	[optional] [default `axResponse::MERGE_VARS`] Possible values are axResponse::MERGE_VARS or axResponse::ADD_VARS

Returns:: axResponse

Definition at line 316 of file axResponse.class.php.

axResponse::addMessage	(	$	message,
		$	level = `self::MESSAGE_WARNING`
	)

Adds a view message.

For convenience, the `$message` parameter will be casted to string. Custom levels are authorized.

Parameters:

string	$message
strign	$level	[optional] [default `axResponse::MESSAGE_WARNING`] One of axResponse::MESSAGE_WARNING,axResponse::MESSAGE_NOTICE, or axResponse::MESSAGE_ALERT or any string describing a level

Returns:: axResponse

Definition at line 499 of file axResponse.class.php.

axResponse::addScript	(	$	script,
		$	type = `"text/javascript"`
	)

Add a view script

Parameters:

string	$script	The `src` attribute of the `<script>` tag
string	$type	[optional] [default `"text/javascript"`] The `type` attribute of the `<script>` tag

Returns:: axResponse

Definition at line 586 of file axResponse.class.php.

axResponse::addStyleSheet	(	$	stylesheet,
		$	type = `"text/css"`,
		$	media = `"screen"`
	)

Add a view style sheet.

Parameters:

string	$stylesheet	The `href` attribute of the `<link>` tag
unknown_type	$type	[optional] [default `"text/css"`] The `type` attribute of the `<link>` tag
unknown_type	$media	[optional] [default `"screen"`] The `media` attribute of the `<link>` tag

Returns:: axResponse

Definition at line 551 of file axResponse.class.php.

axResponse::clearHeaders ( )

Clear all registered headers.

Returns:: axResponse

Definition at line 405 of file axResponse.class.php.

axResponse::clearMessages ( )

Erase all registered messages.

Returns:: axResponse

Definition at line 539 of file axResponse.class.php.

axResponse::clearScripts ( )

Erase all registered scripts.

Returns:: axResponse

Definition at line 609 of file axResponse.class.php.

axResponse::clearStyleSheets ( )

Erase all registered stylesheets.

Returns:: axResponse

Definition at line 575 of file axResponse.class.php.

axResponse::clearVars ( )

Remove all the registered variables.

Returns:: axResponse

Definition at line 338 of file axResponse.class.php.

axResponse::enableLayout ( $ enabled = true )

Enable of disable layout according to the $enabled parameter.

Parameters:

boolean $enabled [optional] [default true]

Returns:: axResponse

Definition at line 224 of file axResponse.class.php.

axResponse::getFilter ( )

Get the registered filter.

See also:: http://php.net/manual/en/function.filter-var-array.php

Returns:: array

Definition at line 460 of file axResponse.class.php.

axResponse::getFormat ( )

Get view format.

Will return null if no format was specified.

Returns:: string

Definition at line 184 of file axResponse.class.php.

axResponse::getHeaders ( )

Get the headers list.

Returns:: array

Definition at line 397 of file axResponse.class.php.

axResponse::getLayout ( )

Get view layout.

Will return null if not layout was specified

Returns:: string

Definition at line 205 of file axResponse.class.php.

axResponse::getMessages ( $ level = null )

Get all view messages, optionnaly filtered by their level.

If no level is provided, all messages from all levels will be returned in a 2 dimentionnal associative array.

Parameters:

string $level [default null]

Returns:: array

Definition at line 528 of file axResponse.class.php.

axResponse::getOutputCallback ( )

Get the output callback.

Will return null if no output callback was set.

Returns:: callback

Definition at line 442 of file axResponse.class.php.

axResponse::getVar ( $ name )

Get the given var.

If a filter was set using axResponse::setFilter, the filter will be applied before the data is returned. Will return null if the corresponding var is not set. Will return false if the filter fails.

Warning:: You will loose all vars that doesn't pass the filter, they'll be set to false.

Parameters:

string $name

Returns:: mixed

Definition at line 247 of file axResponse.class.php.

axResponse::getVars ( )

Get all the registered var.

If a filter was set using axResponse::setFilter, the filter will be applied before the data are returned. Will return false if the filter fails.

Warning:: You will loose all vars that doesn't pass the filter, they'll be set to false.

See also:: http://www.php.net/manual/en/function.filter-var-array.php

Returns:: array

Definition at line 299 of file axResponse.class.php.

axResponse::getView ( )

Get the view name.

Will return null if no view name was specified.

Returns:: string

Definition at line 142 of file axResponse.class.php.

axResponse::getViewSection ( )

Get the view section.

Will return null if no view section was specified.

Returns:: string

Definition at line 163 of file axResponse.class.php.

axResponse::hasFilter ( )

Tells whenever a filter has been registered or not.

Returns:: boolean

Definition at line 450 of file axResponse.class.php.

axResponse::layoutState ( )

Tells if the layout is enabled or not.

Returns:: boolean

Definition at line 233 of file axResponse.class.php.

axResponse::removeMessage ( $ message )

Remove a view message

Parameters:

string $message

Returns:: axResponse

Definition at line 512 of file axResponse.class.php.

axResponse::removeScript ( $ script )

Remove a script (identified by its `src`)

See also:: axResponse::addScript

Parameters:

string $script

Returns:: axResponse

Definition at line 600 of file axResponse.class.php.

axResponse::removeStyleSheet ( $ stylehseet )

Remove a style sheet (identified by its `href` attribute)

See also:: axResponse::addStyleSheet

Parameters:

string $stylehseet

Returns:: axResponse

Definition at line 566 of file axResponse.class.php.

axResponse::reset ( )

Reset the axResponse instance to its initial state.

Returns:: void

Definition at line 120 of file axResponse.class.php.

axResponse::setCookie	(	$	name,
		$	value = `""`,
		$	expire = `0`,
		$	path = `""`,
		$	domain = `""`,
		$	secure = `false`,
		$	httponly = `false`
	)

PHP setcookie alias.

Returns the current instance in case of success, false otherwise.

string $name string $value [optional [default "" integer $expire [optional [default 0 string $path [optional [default "" string $domain [optional [default "" boolean $secure [optional [default false string $httponly [optional [default false boolean

Definition at line 629 of file axResponse.class.php.

axResponse::setFilter ( array $ filter )

Set a response variable filter.

When you set a variable filter, all data you may extract with axResponse::getVar(), axResponse::__get(), or axResponse::getVars() are filtered using filter_var_array before they are returned, allowing you to set sanitize or validation filter, for instance to prevent XSS attacks.

Warning:: The $filter parameter must be compliant with the $definition parameter of PHP's filter_var_array. If the filtering ends up with an error, all variables registered in axResponse are erased and a RuntimeException will be thrown when accessing datas with axResponse::getVar(), axResponse::__get(), or axResponse::getVars().

Note:: The filter will be applied on read so your changes won't take effects until you extract response data with axResponse::getVar(), axResponse::getVars() or with the magic method axResponse::__get().

See also:: http://php.net/manual/en/function.filter-var-array.php

Parameters:

array $filter

Returns:: axResponse

Definition at line 482 of file axResponse.class.php.

axResponse::setFormat ( $ format )

Set view format.

Parameters:

srting $format

Returns:: axResponse

Definition at line 193 of file axResponse.class.php.

axResponse::setHaders ( array $ headers )

Set multiple headers at once.

The $headers parameters must be an associative array which keys are header fields and values header values. Example:

 $response->setHeaders(array(
                   axResponse::HEADER_CONTENT_TYPE         => 'application/octet-stream',
                   axResponse::HEADER_CONTENT_DISCPOSITION => 'attachment; filename=download.abc'
 ));

If some header were previously set, they will be replaced.

See also:: axResponse::addHeader()

Parameters:

array $headers

Returns:: axResponse

Definition at line 375 of file axResponse.class.php.

axResponse::setHeader	(	$	field,
		$	value
	)

Add an header to the header list.

If the header is already present in the list, it will be replaced.

Note:: HTTP Response header fields have been presets as axResponse constants.

Parameters:

string	$field	Should be one of axResponse::HEADER_*
string	$value

Returns:: axResponse

Definition at line 353 of file axResponse.class.php.

axResponse::setLayout ( $ layout )

Set view layout.

Parameters:

string $layout

Returns:: axResponse

Definition at line 214 of file axResponse.class.php.

axResponse::setOutputCallback ( $ callback )

Set a callback to be executed on the output buffer before it is sent to the browser.

Usage:

 // Let's replace all <h1> tags by <h3>
 $response->setOutputCallback(create_function(
     '$buffer',
     'return str_replace(array('<h1>','</h1>'),array('<h3>','</h3>'),$buffer);'
 ));

Callback must be a valid callback (see http://php.net/manual/en/language.pseudo-types.php), false will be returned otherwise.

Parameters:

callback $callback