PHP Class Horde_Alarm_Handler_Notify, horde

Author: Jan Schneider ([email protected])

Inheritance: extends Horde_Alarm_Handler

Protected Properties

Property	Type	Description
$_notification	object	A notification handler injector.
$_soundPlayed	boolean	Whether a sound already had been played during the page request.

Public Methods

Method	Description
__construct ( array $params = null )	Constructor.
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 through Horde_Notification.

Method Details

__construct() public method

Constructor.

public __construct ( array $params = null )
$params	array	Any parameters that the handler might need. Required parameter: - notification: (object) A factory that implements create() and returns a Notification object.

getDescription() public method

Returns a human readable description of the handler.

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() public method

Notifies about an alarm through Horde_Notification.

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

Property Details

$_notification protected property

A notification handler injector.

protected object $_notification
return	object

$_soundPlayed protected property

Whether a sound already had been played during the page request.

protected bool $_soundPlayed
return	boolean