Class Horde_Alarm_Handler_Notify
The Horde_Alarm_Handler_Notification class is a Horde_Alarm handler that
notifies of active alarms over the Horde_Notification system.
-
Horde_Alarm_Handler
-
Horde_Alarm_Handler_Notify
Methods summary
public
|
#
__construct( array $params = null )
Constructor.
Parameters
- $params
- <p>Any parameters that the handler might need.
Required parameter:
- notification: (object) A factory that implements create() and
returns a Notification object.</p>
Throws
|
public
|
#
notify( array $alarm )
Notifies about an alarm through Horde_Notification.
Notifies about an alarm through Horde_Notification.
Parameters
Throws
|
public
string
|
#
getDescription( )
Returns a human readable description of the handler.
Returns a human readable description of the handler.
Returns
string
|
public
array
|
#
getParameters( )
Returns a hash of user-configurable parameters for the handler.
Returns a hash of user-configurable parameters for the handler.
The parameters are hashes with parameter names as keys and parameter
information as values. The parameter information is a hash with the
following keys:
- type: the parameter type as a preference type.
- desc: a parameter description.
- required: whether this parameter is required.
Returns
array
Overrides
|