Class Notification_Listener_status_dimp

Description

The Notification_Listener_status_dimp:: class extends the Notification_Listener_status_imp:: class to return all messages instead of printing them.

$Horde: dimp/lib/Notification/Listener/status.php,v 1.12.2.3 2009/01/06 15:22:39 jan Exp $

Copyright 2005-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /lib/Notification/Listener/status.php (line 21)

Notification_Listener_status_imp
   |
   --Notification_Listener_status_dimp
Variable Summary
Method Summary
 array getStack ([boolean $encode = false])
 boolean handles (string $type)
 void notify (array &$messageStack, [array $options = array()])
Variables
array $_messageStack = array() (line 28)

The notified message stack.

Methods
getStack (line 73)

Returns the message stack.

To return something useful, notify() needs to be called first.

  • return: List of message hashes.
array getStack ([boolean $encode = false])
  • boolean $encode: Encode HTML entities?
handles (line 57)

Handle every message of type dimp.*; otherwise delegate back to the parent.

  • return: Whether this listener handles the type.
boolean handles (string $type)
  • string $type: The message type in question.
notify (line 37)

Returns all status message if there are any on the 'status' message stack.

void notify (array &$messageStack, [array $options = array()])
  • array &$messageStack: The stack of messages.
  • array $options: An array of options.

Documentation generated on Sun, 30 Jan 2011 05:10:55 +0000 by phpDocumentor 1.4.3