Class Zend_Controller_Action_Helper_FlashMessenger

Description

Implements interfaces:

  • IteratorAggregate (internal interface)
  • Countable (internal interface)

Flash Messenger - implement session-based messages

Located in /Controller/Action/Helper/FlashMessenger.php (line 34)

Zend_Controller_Action_Helper_Abstract
   |
   --Zend_Controller_Action_Helper_FlashMessenger
Variable Summary
 static unknown_type $_messageAdded
 static array $_messages
 string $_namespace
Method Summary
 Zend_Controller_Action_Helper_FlashMessenger __construct (string $namespace)
 void addMessage (string $message, string $namespace)
 int count ()
 ArrayObject getIterator ()
 array getMessages (unknown_type $namespace)
 bool hasMessages (string $namespace)
 Zend_Controller_Action_Helper_FlashMessenger setNamespace ([string $namespace = 'default'])
Variables
static unknown_type $_messageAdded = false (line 55)

$_messageAdded - Wether a message has been previously added

  • access: protected
static array $_messages = array() (line 41)

$_messages - Messages from previous request

  • access: protected
static Zend_Session $_session = null (line 48)

$_session - Zend_Session storage object

  • access: protected
string $_namespace = 'default' (line 62)

$_namespace - Instance namespace, default is 'default'

  • access: protected

Inherited Variables

Inherited from Zend_Controller_Action_Helper_Abstract

Zend_Controller_Action_Helper_Abstract::$_actionController
Zend_Controller_Action_Helper_Abstract::$_request
Zend_Controller_Action_Helper_Abstract::$_response
Methods
Constructor __construct (line 69)

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

  • access: public
Zend_Controller_Action_Helper_FlashMessenger __construct (string $namespace)
  • string $namespace
addMessage (line 123)

addMessage() - Add a message to flash message

  • access: public
void addMessage (string $message, string $namespace)
  • string $message
  • string $namespace: OPTIONAL
count (line 209)

count() - Complete the countable interface

  • access: public
int count ()

Implementation of:
Countable::count
getCurrentMessages (line 181)

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

  • access: public
array getCurrentMessages ()
getIterator (line 195)

getIterator() - complete the IteratorAggregate interface, for iterating

  • access: public
ArrayObject getIterator ()

Implementation of:
IteratorAggregate::getIterator
getMessages (line 155)

getMessages() - Get messages from a specific namespace

  • access: public
array getMessages (unknown_type $namespace)
  • unknown_type $namespace
hasCurrentMessages (line 170)

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

  • access: public
bool hasCurrentMessages ()
hasMessages (line 144)

hasMessages() - Wether a specific namespace has messages

  • access: public
bool hasMessages (string $namespace)
  • string $namespace
postDispatch (line 87)

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)

  • access: public

Redefinition of:
Zend_Controller_Action_Helper_Abstract::postDispatch()
Hook into action controller postDispatch() workflow
resetNamespace (line 111)

resetNamespace() - reset the namespace to the default

  • access: public
setNamespace (line 100)

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

  • access: public
Zend_Controller_Action_Helper_FlashMessenger setNamespace ([string $namespace = 'default'])
  • string $namespace

Inherited Methods

Inherited From Zend_Controller_Action_Helper_Abstract

 Zend_Controller_Action_Helper_Abstract::getActionController()
 Zend_Controller_Action_Helper_Abstract::getName()
 Zend_Controller_Action_Helper_Abstract::getRequest()
 Zend_Controller_Action_Helper_Abstract::getResponse()
 Zend_Controller_Action_Helper_Abstract::init()
 Zend_Controller_Action_Helper_Abstract::postDispatch()
 Zend_Controller_Action_Helper_Abstract::preDispatch()
 Zend_Controller_Action_Helper_Abstract::setActionController()

Documentation generated on Sun, 27 May 2007 23:23:59 -0700 by phpDocumentor 1.3.2