PHP Class Horde_Alarm_Handler, horde

Author: Jan Schneider ([email protected])

Public Properties

Property	Type	Description
$alarm		Horde_Alarm

Public Methods

Method	Description
getDescription ( ) : string	Returns a human readable description of the handler.
getParameters ( ) : array	Returns a hash of user-configurable parameters for the handler.
notify ( array $alarm )	Notifies about an alarm.
reset ( array $alarm )	Resets the internal status of the handler, so that alarm notifications are sent again.

Method Details

getDescription() abstract public method

Returns a human readable description of the handler.

abstract public getDescription ( ) : string
return	string

getParameters() public method

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.

public getParameters ( ) : array
return	array

notify() abstract public method

Notifies about an alarm.

abstract public notify ( array $alarm )
$alarm	array	An alarm hash.

reset() public method

Resets the internal status of the handler, so that alarm notifications are sent again.

public reset ( array $alarm )
$alarm	array	An alarm hash.

Property Details

$alarm public property

Horde_Alarm

public $alarm