Detailed Description

Messages are sent between Controllers and are used to transfer data between them.

They are are dispatched by ActionMapper, which decides upon the message's controller, context and action parameter to which Controller it will be send.

Author: ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 23 of file ControllerMessage.php.

Inheritance diagram for ControllerMessage:

Public Member Functions
	setSender ($sender)

	getSender ()

	setContext ($context)

	getContext ()

	setAction ($action)

	getAction ()

	setFormat ($format)

	getFormat ()

	setHeader ($name, $value)

	setHeaders (array $headers)

	getHeader ($name, $default=null)

	getHeaders ()

	clearHeader ($name)

	clearHeaders ()

	hasHeader ($name)

	setValue ($name, $value)

	setValues (array $values)

	getValue ($name, $default=null, $filter=null, $options=null)

	getBooleanValue ($name, $default=false)

	getValues ()

	clearValue ($name)

	clearValues ()

	hasValue ($name)

	setProperty ($name, $value)

	getProperty ($name)

	addError (ApplicationError $error)

	setErrors (array $errors)

	getErrors ()

	clearErrors ()

	hasErrors ()

Member Function Documentation

setSender ( $sender )

Set the name of the sending Controller.

Parameters

$sender The name of the Controller

Implemented in AbstractControllerMessage.

getSender ( )

Get the name of the sending Controller.

Returns: The name of the Controller

Implemented in AbstractControllerMessage.

setContext ( $context )

Set the name of the context.

Parameters

$context The name of the context

Implemented in AbstractControllerMessage.

getContext ( )

Get the name of the context.

Returns: The name of the context

Implemented in AbstractControllerMessage.

setAction ( $action )

Set the name of the action.

Parameters

$action The name of the action

Implemented in AbstractControllerMessage.

getAction ( )

Get the name of the action.

Returns: The name of the action

Implemented in AbstractControllerMessage.

setFormat ( $format )

Set the message format.

Parameters

$format A key of the configuration section 'Formats'

Implemented in AbstractControllerMessage.

getFormat ( )

Get the message format.

If no explicit format is set, the format is derived from the Content-Type header value, if existing. If no format can be derived, the first format in the configuration section 'Formats' will be used.

Returns: String

Implemented in AbstractControllerMessage.

setHeader	(	$name,
		$value
	)

Set a header value.

Parameters

$name	The header name
$value	The header value

Implemented in AbstractControllerMessage.

setHeaders ( array $headers )

Set all headers at once.

Parameters

$headers The associative array

Implemented in AbstractControllerMessage.

getHeader	(	$name,
		$default = `null`
	)

Get a header value.

Parameters

$name	The header name
$default	The default value if the header is not defined (default: null)

Returns: The header value or default, if it does not exist

Implemented in AbstractControllerMessage.

getHeaders ( )

Get all key headers.

Returns: An associative array

Implemented in AbstractControllerMessage.

clearHeader ( $name )

Remove a header.

Parameters

$name The name of the header

Implemented in AbstractControllerMessage.

clearHeaders ( )

Remove all headers.

Implemented in AbstractControllerMessage.

hasHeader ( $name )

Check for existance of a header.

Parameters

$name The name of the header

Returns: Boolean whether the header exists or not exist

Implemented in AbstractControllerMessage.

setValue	(	$name,
		$value
	)

Set a value.

Parameters

$name	The name of the variable
$value	The value of the variable

Implemented in AbstractControllerMessage.

setValues ( array $values )

Set all key value pairs at once.

Parameters

$values The associative array

Implemented in AbstractControllerMessage.

getValue	(	$name,
		$default = `null`,
		$filter = `null`,
		$options = `null`
	)

Get a value.

Parameters

$name	The name of the variable
$default	The default value if the value is not defined (optional, default: null)
$filter	PHP filter constant (FILTER_SANITIZE/FILTER_VALIDATE) to be applied to the value (optional, default: null)
$options	Filter parameters (optional, default: null)