\Horde_Notification_Handler_Decorator_Alarm

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.

Summary

Methods
Properties
Constants
push()
notify()
__construct()
No public properties found
No constants found
No protected methods found
$_alarm
$_user
N/A
No private methods found
No private properties found
N/A

Properties

$_alarm

$_alarm : \Horde_Core_Factory_Alarm

A Horde_Alarm instance.

Type

\Horde_Core_Factory_Alarm

$_user

$_user : string

The current user.

Type

string

Methods

push()

push(\Horde_Notification_Event  $event, array  $options) 

Event is being added to the Horde message stack.

Parameters

\Horde_Notification_Event $event

Event object.

array $options

Additional options (see Horde_Notification_Handler for details).

notify()

notify(\Horde_Notification_Handler  $handler, \Horde_Notification_Listener  $listener) 

Listeners are handling their messages.

Parameters

\Horde_Notification_Handler $handler

The base handler object.

\Horde_Notification_Listener $listener

The Listener object that is handling its messages.

Throws

\Horde_Notification_Exception

__construct()

__construct(object  $alarm, string  $user) 

Initialize the notification system, set up any needed session variables, etc.

Parameters

object $alarm

An alarm factory that implements create().

string $user

The current username.