Overview

Packages

  • Alarm

Classes

  • Horde_Alarm
  • Horde_Alarm_Exception
  • Horde_Alarm_Handler
  • Horde_Alarm_Handler_Desktop
  • Horde_Alarm_Handler_Mail
  • Horde_Alarm_Handler_Notify
  • Horde_Alarm_Null
  • Horde_Alarm_Object
  • Horde_Alarm_Sql
  • Horde_Alarm_Translation
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Alarm_Handler

The Horde_Alarm_Handler class is an interface for all Horde_Alarm handlers that notifies of active alarms.

Direct known subclasses

Horde_Alarm_Handler_Desktop, Horde_Alarm_Handler_Mail, Horde_Alarm_Handler_Notify
Abstract
Package: Alarm
Author: Jan Schneider jan@horde.org
Located at Horde/Alarm/Handler.php
Methods summary
abstract public
# notify( array $alarm )

Notifies about an alarm.

Notifies about an alarm.

Parameters

$alarm
An alarm hash.

Throws

Horde_Alarm_Exception
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

$alarm
An alarm hash.
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

#
API documentation generated by ApiGen