Horde_Core_Alarm_Handler_Notify
extends Horde_Alarm_Handler
in package
A Horde_Alarm handler that notifies of active alarms over the Horde_Notification system.
Tags
Table of Contents
Properties
- $_soundPlayed : bool
- Whether a sound already had been played during the page request.
Methods
- getDescription() : string
- Returns a human readable description of the handler.
- getParameters() : array<string|int, mixed>
- Returns a hash of user-configurable parameters for the handler.
- notify() : mixed
- Notifies about an alarm through Horde_Notification.
Properties
$_soundPlayed
Whether a sound already had been played during the page request.
protected
bool
$_soundPlayed
= \false
Methods
getDescription()
Returns a human readable description of the handler.
public
getDescription() : string
Return values
stringgetParameters()
Returns a hash of user-configurable parameters for the handler.
public
getParameters() : array<string|int, mixed>
The parameters are hashes with parameter names as keys and parameter information as values. The parameter information is a hash with the following keys:
- desc: a parameter description.
- required: whether this parameter is required.
- type: the parameter type as a preference type.
Return values
array<string|int, mixed>notify()
Notifies about an alarm through Horde_Notification.
public
notify(array<string|int, mixed> $alarm) : mixed
Parameters
- $alarm : array<string|int, mixed>
-
An alarm hash.