Zend Framework  1.12
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Zend_Controller_Action_Helper_FlashMessenger Class Reference

Public Member Functions

 __construct ()
 __construct() - Instance constructor, needed to get iterators, etc
 
 postDispatch ()
 postDispatch() - runs after action is dispatched, in this case, it is resetting the namespace in case we have forwarded to a different action, Flashmessage will be 'clean' (default namespace)
 
 setNamespace ($namespace= 'default')
 setNamespace() - change the namespace messages are added to, useful for per action controller messaging between requests
 
 getNamespace ()
 getNamespace() - return the current namepsace
 
 resetNamespace ()
 resetNamespace() - reset the namespace to the default
 
 addMessage ($message, $namespace=null)
 addMessage() - Add a message to flash message
 
 hasMessages ($namespace=null)
 hasMessages() - Wether a specific namespace has messages
 
 getMessages ($namespace=null)
 getMessages() - Get messages from a specific namespace
 
 clearMessages ($namespace=null)
 Clear all messages from the previous request & current namespace.
 
 hasCurrentMessages ($namespace=null)
 hasCurrentMessages() - check to see if messages have been added to current namespace within this request
 
 getCurrentMessages ($namespace=null)
 getCurrentMessages() - get messages that have been added to the current namespace within this request
 
 clearCurrentMessages ($namespace=null)
 clear messages from the current request & current namespace
 
 getIterator ($namespace=null)
 getIterator() - complete the IteratorAggregate interface, for iterating
 
 count ($namespace=null)
 count() - Complete the countable interface
 
 direct ($message, $namespace=NULL)
 Strategy pattern: proxy to addMessage()
 
- Public Member Functions inherited from Zend_Controller_Action_Helper_Abstract
 setActionController (Zend_Controller_Action $actionController=null)
 setActionController()
 
 getActionController ()
 Retrieve current action controller.
 
 getFrontController ()
 Retrieve front controller instance.
 
 init ()
 Hook into action controller initialization.
 
 preDispatch ()
 Hook into action controller preDispatch() workflow.
 
 postDispatch ()
 Hook into action controller postDispatch() workflow.
 
 getRequest ()
 getRequest() -
 
 getResponse ()
 getResponse() -
 
 getName ()
 getName()
 

Protected Attributes

 $_namespace = 'default'
 
- Protected Attributes inherited from Zend_Controller_Action_Helper_Abstract
 $_actionController = null
 $_actionController
 
 $_frontController = null
 

Static Protected Attributes

static $_messages = array()
 
static $_session = null
 
static $_messageAdded = false
 

Constructor & Destructor Documentation

__construct ( )

__construct() - Instance constructor, needed to get iterators, etc

Parameters
string$namespace
Returns
void

Member Function Documentation

addMessage (   $message,
  $namespace = null 
)

addMessage() - Add a message to flash message

Parameters
string$message
Returns
Zend_Controller_Action_Helper_FlashMessenger Provides a fluent interface
clearCurrentMessages (   $namespace = null)

clear messages from the current request & current namespace

Returns
boolean
clearMessages (   $namespace = null)

Clear all messages from the previous request & current namespace.

Returns
boolean True if messages were cleared, false if none existed
count (   $namespace = null)

count() - Complete the countable interface

Returns
int
direct (   $message,
  $namespace = NULL 
)

Strategy pattern: proxy to addMessage()

Parameters
string$message
Returns
void
getCurrentMessages (   $namespace = null)

getCurrentMessages() - get messages that have been added to the current namespace within this request

Returns
array
getIterator (   $namespace = null)

getIterator() - complete the IteratorAggregate interface, for iterating

Returns
ArrayObject
getMessages (   $namespace = null)

getMessages() - Get messages from a specific namespace

Returns
array
getNamespace ( )

getNamespace() - return the current namepsace

Returns
string
hasCurrentMessages (   $namespace = null)

hasCurrentMessages() - check to see if messages have been added to current namespace within this request

Returns
boolean
hasMessages (   $namespace = null)

hasMessages() - Wether a specific namespace has messages

Returns
boolean
postDispatch ( )

postDispatch() - runs after action is dispatched, in this case, it is resetting the namespace in case we have forwarded to a different action, Flashmessage will be 'clean' (default namespace)

Returns
Zend_Controller_Action_Helper_FlashMessenger Provides a fluent interface
resetNamespace ( )

resetNamespace() - reset the namespace to the default

Returns
Zend_Controller_Action_Helper_FlashMessenger Provides a fluent interface
setNamespace (   $namespace = 'default')

setNamespace() - change the namespace messages are added to, useful for per action controller messaging between requests

Parameters
string$namespace
Returns
Zend_Controller_Action_Helper_FlashMessenger Provides a fluent interface

Member Data Documentation

$_messageAdded = false
staticprotected
$_messages = array()
staticprotected
$_namespace = 'default'
protected
$_session = null
staticprotected