Horde_Notification_Listener
in package
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.
Tags
Table of Contents
- $_handles : array<string|int, mixed>
- Array of message types that this listener handles.
- $_name : string
- The base type of this listener.
- addType() : mixed
- Adds message type handler.
- getName() : string
- Return a unique identifier for this listener.
- handles() : mixed
- Does this listener handle a certain type of message?
- notify() : mixed
- Outputs the status line, sends emails, pages, etc., if there are any messages on this listener's message stack.
Properties
$_handles
Array of message types that this listener handles.
protected
array<string|int, mixed>
$_handles
= array()
Key is the type, value is the default class name of the Event type to use.
$_name
The base type of this listener.
protected
string
$_name
Methods
addType()
Adds message type handler.
public
addType(string $type, string $class) : mixed
Parameters
- $type : string
-
The type identifier.
- $class : string
-
A classname.
Return values
mixed —getName()
Return a unique identifier for this listener.
public
getName() : string
Return values
string —Unique id.
handles()
Does this listener handle a certain type of message?
public
handles(string $type) : mixed
Parameters
- $type : string
-
The message type in question.
Return values
mixed —False if this listener does not handle, the default event class if it does handle the type.
notify()
Outputs the status line, sends emails, pages, etc., if there are any messages on this listener's message stack.
public
abstract notify(array<string|int, mixed> $events[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $events : array<string|int, mixed>
-
The list of events to handle.
- $options : array<string|int, mixed> = array()
-
An array of options.