AbstractControllerMessage Class Reference

Detailed Description

AbstractControllerMessage is the base class for request/response implementations.

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

Definition at line 27 of file AbstractControllerMessage.php.

+ Inheritance diagram for AbstractControllerMessage:

Public Member Functions

 __construct (Formatter $formatter)
 
 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, $validateDesc=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 ()
 
 __toString ()
 

Protected Member Functions

 getFormatter ()
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( Formatter  $formatter)

Constructor.

Parameters
$formatter

Definition at line 78 of file AbstractControllerMessage.php.

Member Function Documentation

◆ setSender()

setSender (   $sender)
See also
ControllerMessage::setSender()

Implements ControllerMessage.

Definition at line 85 of file AbstractControllerMessage.php.

◆ getSender()

getSender ( )
See also
ControllerMessage::getSender()

Implements ControllerMessage.

Definition at line 92 of file AbstractControllerMessage.php.

◆ setContext()

setContext (   $context)
See also
ControllerMessage::setContext()

Implements ControllerMessage.

Definition at line 99 of file AbstractControllerMessage.php.

◆ getContext()

getContext ( )

◆ setAction()

setAction (   $action)
See also
ControllerMessage::setAction()

Implements ControllerMessage.

Definition at line 113 of file AbstractControllerMessage.php.

◆ getAction()

getAction ( )
See also
ControllerMessage::getAction()

Implements ControllerMessage.

Definition at line 120 of file AbstractControllerMessage.php.

◆ setFormat()

setFormat (   $format)
See also
ControllerMessage::setFormat()

Implements ControllerMessage.

Definition at line 127 of file AbstractControllerMessage.php.

◆ getFormat()

getFormat ( )
See also
ControllerMessage::getFormat()

Implements ControllerMessage.

Definition at line 134 of file AbstractControllerMessage.php.

◆ setHeader()

setHeader (   $name,
  $value 
)
See also
ControllerMessage::setHeader()

Implements ControllerMessage.

Definition at line 144 of file AbstractControllerMessage.php.

◆ setHeaders()

setHeaders ( array  $headers)

◆ getHeader()

getHeader (   $name,
  $default = null 
)
See also
ControllerMessage::getHeader()

Implements ControllerMessage.

Definition at line 158 of file AbstractControllerMessage.php.

◆ getHeaders()

getHeaders ( )

◆ clearHeader()

clearHeader (   $name)

◆ clearHeaders()

clearHeaders ( )

◆ hasHeader()

hasHeader (   $name)
See also
ControllerMessage::hasHeader()

Implements ControllerMessage.

Definition at line 191 of file AbstractControllerMessage.php.

◆ setValue()

setValue (   $name,
  $value 
)
See also
ControllerMessage::setValue()

Implements ControllerMessage.

Definition at line 198 of file AbstractControllerMessage.php.

◆ setValues()

setValues ( array  $values)
See also
ControllerMessage::setValues()

Implements ControllerMessage.

Definition at line 205 of file AbstractControllerMessage.php.

◆ getValue()

getValue (   $name,
  $default = null,
  $validateDesc = null 
)
See also
ControllerMessage::getValue()

Implements ControllerMessage.

Definition at line 212 of file AbstractControllerMessage.php.

◆ getBooleanValue()

getBooleanValue (   $name,
  $default = false 
)

◆ getValues()

getValues ( )
See also
ControllerMessage::getValues()

Implements ControllerMessage.

Definition at line 241 of file AbstractControllerMessage.php.

◆ clearValue()

clearValue (   $name)

◆ clearValues()

clearValues ( )

◆ hasValue()

hasValue (   $name)
See also
ControllerMessage::hasValue()

Implements ControllerMessage.

Definition at line 262 of file AbstractControllerMessage.php.

◆ setProperty()

setProperty (   $name,
  $value 
)

◆ getProperty()

getProperty (   $name)

◆ addError()

addError ( ApplicationError  $error)
See also
ControllerMessage::addError()

Implements ControllerMessage.

Definition at line 286 of file AbstractControllerMessage.php.

◆ setErrors()

setErrors ( array  $errors)
See also
ControllerMessage::setErrors()

Implements ControllerMessage.

Definition at line 293 of file AbstractControllerMessage.php.

◆ getErrors()

getErrors ( )
See also
ControllerMessage::getErrors()

Implements ControllerMessage.

Definition at line 300 of file AbstractControllerMessage.php.

◆ clearErrors()

clearErrors ( )

◆ hasErrors()

hasErrors ( )
See also
ControllerMessage::hasErrors()

Implements ControllerMessage.

Definition at line 314 of file AbstractControllerMessage.php.

◆ getFormatter()

getFormatter ( )
protected

Get the Formatter instance.

Returns
Formatter

Definition at line 322 of file AbstractControllerMessage.php.

◆ __toString()

__toString ( )

Get a string representation of the message.

Returns
The string

Definition at line 330 of file AbstractControllerMessage.php.