Horde_Notification_Handler_Decorator_Alarm
extends Horde_Notification_Handler_Decorator_Base
in package
The Alarm Decorator notifies the alarm system to push its notifications on the stack.
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
- $_alarm : Horde_Core_Factory_Alarm
- A Horde_Alarm instance.
- $_user : string
- The current user.
- __construct() : mixed
- Initialize the notification system, set up any needed session variables, etc.
- notify() : mixed
- Listeners are handling their messages.
- push() : mixed
- Event is being added to the Horde message stack.
Properties
$_alarm
A Horde_Alarm instance.
protected
Horde_Core_Factory_Alarm
$_alarm
$_user
The current user.
protected
string
$_user
Methods
__construct()
Initialize the notification system, set up any needed session variables, etc.
public
__construct(object $alarm, string $user) : mixed
Parameters
- $alarm : object
-
An alarm factory that implements create().
- $user : string
-
The current username.
Return values
mixed —notify()
Listeners are handling their messages.
public
notify(Horde_Notification_Handler $handler, Horde_Notification_Listener $listener) : mixed
Parameters
- $handler : Horde_Notification_Handler
-
The base handler object.
- $listener : Horde_Notification_Listener
-
The Listener object that is handling its messages.
Tags
Return values
mixed —push()
Event is being added to the Horde message stack.
public
push(Horde_Notification_Event $event, array<string|int, mixed> $options) : mixed
Parameters
- $event : Horde_Notification_Event
-
Event object.
- $options : array<string|int, mixed>
-
Additional options (see Horde_Notification_Handler for details).