Overview

Packages

  • Notification

Classes

  • Horde_Notification
  • Horde_Notification_Event
  • Horde_Notification_Event_Status
  • Horde_Notification_Exception
  • Horde_Notification_Handler
  • Horde_Notification_Handler_Decorator_Alarm
  • Horde_Notification_Handler_Decorator_Base
  • Horde_Notification_Handler_Decorator_Log
  • Horde_Notification_Listener
  • Horde_Notification_Listener_Audio
  • Horde_Notification_Listener_Status
  • Horde_Notification_Storage_Object
  • Horde_Notification_Storage_Session

Interfaces

  • Horde_Notification_Storage_Interface
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Notification_Listener

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

Copyright 2001-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Direct known subclasses

Horde_Notification_Listener_Audio, Horde_Notification_Listener_Status
Abstract
Package: Notification
Category: Horde
License: LGPL 2.1
Author: Chuck Hagenbuch chuck@horde.org
Located at Horde/Notification/Listener.php
Methods summary
public mixed
# handles( string $type )

Does this listener handle a certain type of message?

Does this listener handle a certain type of message?

Parameters

$type
The message type in question.

Returns

mixed

False if this listener does not handle, the default event class if it does handle the type.

public
# addType( string $type, string $class )

Adds message type handler.

Adds message type handler.

Parameters

$type
The type identifier.
$class
A classname.
public string
# getName( )

Return a unique identifier for this listener.

Return a unique identifier for this listener.

Returns

string
Unique id.
abstract public
# notify( array $events, array $options = array() )

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

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

Parameters

$events
The list of events to handle.
$options
An array of options.
API documentation generated by ApiGen