Class Notification_Listener

Description

The Notification_Listener:: class provides functionality for displaying messages from the message stack as a status line.

$Horde: framework/Notification/Notification/Listener.php,v 1.16.2.14 2009/01/06 15:23:28 jan Exp $

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

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

Located in /Notification/Notification/Listener.php (line 17)


	
			
Direct descendents
Class Description
 class Notification_Listener_audio The Notification_Listener_audio:: class provides functionality for inserting embedded audio notifications from the stack into the page.
 class Notification_Listener_javascript The Notification_Listener_javascript:: class provides functionality for inserting javascript code from the message stack into the page.
 class Notification_Listener_status The Notification_Listener_status:: class provides functionality for displaying messages from the message stack as a status line.
Variable Summary
 array $_handles
Method Summary
 Notification_Listener Notification_Listener ()
 void getEvent ( $message)
 array getFlags ( $message)
 void getMessage (array $message)
 string getName ()
 boolean handles (string $type)
 void notify ( &$messageStacks, [array $options = array()], array &$messageStack)
Variables
array $_handles = array() (line 24)

Array of message types that this listener handles.

Methods
Constructor Notification_Listener (line 29)

Constructor

Notification_Listener Notification_Listener ()
getEvent (line 80)

Unserialize an event from the message stack, checking to see if the appropriate class exists and kludging it into a base Notification_Event object if not.

void getEvent ( $message)
  • $message
getFlags (line 136)

Unserialize an array of event flags from the message stack. If this event has no flags, or the flags array could not be unserialized, an empty array is returned.

  • return: An array of flags.
array getFlags ( $message)
  • $message
getMessage (line 71)

Processes one message from the message stack.

void getMessage (array $message)
  • array $message: One message hash from the stack.

Redefined in descendants as:
getName (line 50)

Return a unique identifier for this listener.

  • return: Unique id.
string getName ()

Redefined in descendants as:
handles (line 40)

Does this listener handle a certain type of message?

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

Outputs the status line, sends emails, pages, etc., if there are any messages on this listener's message stack.

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

Redefined in descendants as:

Documentation generated on Sun, 30 Jan 2011 05:19:16 +0000 by phpDocumentor 1.4.3