Flash Messenger - implement session-based messages

uses
category Zend
package Zend_Controller
subpackage Zend_Controller_Action_Helper
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
version $Id$
inherited_from \Zend_Controller_Action_Helper_Abstract

 Methods

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

__construct() : void

addMessage() - Add a message to flash message

addMessage(string $message, $namespace = null) : \Zend_Controller_Action_Helper_FlashMessenger

Parameters

$message

string

$namespace

Returns

\Zend_Controller_Action_Helper_FlashMessengerProvides a fluent interface

clear messages from the current request & current namespace

clearCurrentMessages($namespace = null) : boolean

Parameters

$namespace

Returns

boolean

Clear all messages from the previous request & current namespace

clearMessages($namespace = null) : boolean

Parameters

$namespace

Returns

booleanTrue if messages were cleared, false if none existed

count() - Complete the countable interface

count($namespace = null) : integer

Parameters

$namespace

Returns

integer

Strategy pattern: proxy to addMessage()

direct(string $message, $namespace = NULL) : void

Parameters

$message

string

$namespace

Retrieve current action controller

getActionController() : \Zend_Controller_Action
Inherited

Returns

\Zend_Controller_Action

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

getCurrentMessages($namespace = null) : array

Parameters

$namespace

Returns

array

Retrieve front controller instance

getFrontController() : \Zend_Controller_Front
Inherited

Returns

\Zend_Controller_Front

getIterator() - complete the IteratorAggregate interface, for iterating

getIterator($namespace = null) : \ArrayObject

Parameters

$namespace

Returns

\ArrayObject

getMessages() - Get messages from a specific namespace

getMessages($namespace = null) : array

Parameters

$namespace

Returns

array

getName()

getName() : string
Inherited

Returns

string

getNamespace() - return the current namepsace

getNamespace() : string

Returns

string

getRequest() -

getRequest() : \Zend_Controller_Request_Abstract
Inherited

Returns

\Zend_Controller_Request_Abstract$request

getResponse() -

getResponse() : \Zend_Controller_Response_Abstract
Inherited

Returns

\Zend_Controller_Response_Abstract$response

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

hasCurrentMessages($namespace = null) : boolean

Parameters

$namespace

Returns

boolean

hasMessages() - Wether a specific namespace has messages

hasMessages($namespace = null) : boolean

Parameters

$namespace

Returns

boolean

Hook into action controller initialization

init() : void
Inherited

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)

postDispatch() : \Zend_Controller_Action_Helper_FlashMessenger
inherited_from \Zend_Controller_Action_Helper_Abstract::postDispatch()

Returns

\Zend_Controller_Action_Helper_FlashMessengerProvides a fluent interface

Hook into action controller postDispatch() workflow

postDispatch() : void
Inherited

Hook into action controller preDispatch() workflow

preDispatch() : void
Inherited

resetNamespace() - reset the namespace to the default

resetNamespace() : \Zend_Controller_Action_Helper_FlashMessenger

Returns

\Zend_Controller_Action_Helper_FlashMessengerProvides a fluent interface

setActionController()

setActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_Abstract
Inherited

Parameters

$actionController

\Zend_Controller_Action

Returns

\Zend_Controller_ActionHelper_AbstractProvides a fluent interface

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

setNamespace(string $namespace = 'default') : \Zend_Controller_Action_Helper_FlashMessenger

Parameters

$namespace

string

Returns

\Zend_Controller_Action_Helper_FlashMessengerProvides a fluent interface

 Properties

 

$_actionController

$_actionController : \Zend_Controller_Action

Default

null
 

$_frontController

$_frontController : mixed

Default

null
 

$_messageAdded - Wether a message has been previously added

$_messageAdded : boolean

Default

false
Static
 

$_messages - Messages from previous request

$_messages : array

Default

array()
Static
 

$_namespace - Instance namespace, default is 'default'

$_namespace : string

Default

'default'
 

$_session - Zend_Session storage object

$_session : \Zend_Session

Default

null
Static