Controller/Action/Helper/FlashMessenger.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Zend_Controller_Action_Helper
Classes: Zend_Controller_Action_Helper_FlashMessenger

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Controller_Action_Helper_FlashMessenger
jump to top

Extends from: Zend_Controller_Action_Helper_Abstract
Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Zend_Controller_Action_Helper
uses: Zend_Controller_Action_Helper_Abstract
version: $Id: FlashMessenger.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties: $_messages; $_session; $_messageAdded; $_namespace
Methods: __construct; postDispatch; setNamespace; resetNamespace; addMessage; hasMessages; getMessages; clearMessages; hasCurrentMessages; getCurrentMessages; clearCurrentMessages; getIterator; count; direct

Description

Flash Messenger - implement session-based messages

Properties

$_messageAdded
jump to class

boolean $_messageAdded = 'false'

$_messageAdded - Wether a message has been previously added

Details

$_messageAdded: boolean
visibility: protected
default: false
final: false
static: true

$_messages
jump to class

array $_messages = 'array'

$_messages - Messages from previous request

Details

$_messages: array
visibility: protected
default: array
final: false
static: true

$_namespace
jump to class

string $_namespace = 'default'

$_namespace - Instance namespace, default is 'default'

Details

$_namespace: string
visibility: protected
default: default
final: false
static: false

$_session
jump to class

Zend_Session $_session = 'null'

$_session - Zend_Session storage object

Details

$_session: Zend_Session
visibility: protected
default: null
final: false
static: true

Methods

__construct
jump to class

__construct(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: false

addMessage
jump to class

addMessage(
          string $message
          )
        
        :
        Zend_Controller_Action_Helper_FlashMessenger

addMessage() - Add a message to flash message

Arguments

$message: string

Output

Zend_Controller_Action_Helper_FlashMessenger: Provides a fluent interface

Details

visibility: public
final: false
static: false

clearCurrentMessages
jump to class

clearCurrentMessages(
          
          )
        
        :
        boolean

clear messages from the current request & current namespace

Output

boolean

Details

visibility: public
final: false
static: false

clearMessages
jump to class

clearMessages(
          
          )
        
        :
        boolean

Clear all messages from the previous request & current namespace

Output

boolean: True if messages were cleared, false if none existed

Details

visibility: public
final: false
static: false

count
jump to class

count() - Complete the countable interface

Output

int

Details

visibility: public
final: false
static: false

direct
jump to class

direct(
          string $message
          )
        
        :
        void

Strategy pattern: proxy to addMessage()

Arguments

$message: string

Details

visibility: public
final: false
static: false

getCurrentMessages
jump to class

getCurrentMessages(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

getIterator
jump to class

getIterator(
          
          )
        
        :
        ArrayObject

getIterator() - complete the IteratorAggregate interface, for iterating

Output

ArrayObject

Details

visibility: public
final: false
static: false

getMessages
jump to class

getMessages(
          
          )
        
        :
        array

getMessages() - Get messages from a specific namespace

Output

array

Details

visibility: public
final: false
static: false

hasCurrentMessages
jump to class

hasCurrentMessages(
          
          )
        
        :
        boolean

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

Output

boolean

Details

visibility: public
final: false
static: false

hasMessages
jump to class

hasMessages(
          
          )
        
        :
        boolean

hasMessages() - Wether a specific namespace has messages

Output

boolean

Details

visibility: public
final: false
static: false

postDispatch
jump to class

postDispatch(
          
          )
        
        :
        Zend_Controller_Action_Helper_FlashMessenger

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)

Output

Zend_Controller_Action_Helper_FlashMessenger: Provides a fluent interface

Details

visibility: public
final: false
static: false

resetNamespace
jump to class

resetNamespace(
          
          )
        
        :
        Zend_Controller_Action_Helper_FlashMessenger

resetNamespace() - reset the namespace to the default

Output

Zend_Controller_Action_Helper_FlashMessenger: Provides a fluent interface

Details

visibility: public
final: false
static: false

setNamespace
jump to class

setNamespace(
          string $namespace
              =
              default
          )
        
        :
        Zend_Controller_Action_Helper_FlashMessenger

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

Arguments

$namespace: string

Output

Zend_Controller_Action_Helper_FlashMessenger: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Controller/Action/Helper/FlashMessenger.php

Description

Zend_Controller_Action_Helper_FlashMessengerjump to top

Description

Properties

$_messageAddedjump to class

Details

$_messagesjump to class

Details

$_namespacejump to class

Details

$_sessionjump to class

Details

Methods

__constructjump to class

Details

addMessagejump to class

Arguments

Output

Details

clearCurrentMessagesjump to class

Output

Details

clearMessagesjump to class

Output

Details

countjump to class

Output

Details

directjump to class

Arguments

Details

getCurrentMessagesjump to class

Output

Details

getIteratorjump to class

Output

Details

getMessagesjump to class

Output

Details

hasCurrentMessagesjump to class

Output

Details

hasMessagesjump to class

Output

Details

postDispatchjump to class

Output

Details

resetNamespacejump to class

Output

Details

setNamespacejump to class

Arguments

Output

Details

Zend_Controller_Action_Helper_FlashMessenger
jump to top

$_messageAdded
jump to class

$_messages
jump to class

$_namespace
jump to class

$_session
jump to class

__construct
jump to class

addMessage
jump to class

clearCurrentMessages
jump to class

clearMessages
jump to class

count
jump to class

direct
jump to class

getCurrentMessages
jump to class

getIterator
jump to class

getMessages
jump to class

hasCurrentMessages
jump to class

hasMessages
jump to class

postDispatch
jump to class

resetNamespace
jump to class

setNamespace
jump to class