Class Horde_Alarm_Handler
The Horde_Alarm_Handler class is an interface for all Horde_Alarm handlers
that notifies of active alarms.
Methods summary
abstract public
|
#
notify( array $alarm )
Notifies about an alarm.
Parameters
Throws
|
public
|
#
reset( array $alarm )
Resets the internal status of the handler, so that alarm notifications
are sent again.
Resets the internal status of the handler, so that alarm notifications
are sent again.
Parameters
|
abstract 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
|
Properties summary
public
mixed
|
$alarm
The alarm object to that this handler is attached.
The alarm object to that this handler is attached.
Horde_Alarm
|
|