API Documentation
\

\Horde_Notification_Listener

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

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

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

Summary

Methods
Properties
Constants
handles()
addType()
getName()
notify()
No public properties found
No constants found
No protected methods found
$_name
$_handles
N/A
No private methods found
No private properties found
N/A

Properties

$_name

$_name : string

The base type of this listener.

Type

string

$_handles

$_handles : array

Array of message types that this listener handles.

Key is the type, value is the default class name of the Event type to use.

Type

array

Methods

handles()

handles(string  $type) : mixed

Does this listener handle a certain type of message?

Parameters

string $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.

addType()

addType(string  $type, string  $class)

Adds message type handler.

Parameters

string $type

The type identifier.
string $class

A classname.

getName()

getName() : string

Return a unique identifier for this listener.

Returns

string —

Unique id.

notify()

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.

Parameters

array $events

The list of events to handle.
array $options

An array of options.