Horde_Core_Factory_Alarm
extends Horde_Core_Factory_Base
in package
A Horde_Injector:: based Horde_Core_Ajax_Application:: factory.
Copyright 2010-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Properties
- $_alarm : Horde_Alarm
- A Horde_Alarm instance.
- $_injector : Horde_Injector
- The injector.
- $_ttl : int
- TTL value.
Methods
- __construct() : mixed
- Constructor.
- create() : Horde_Alarm
- Return a Horde_Alarm instance.
- load() : mixed
- Retrieves active alarms from all applications and stores them in the backend.
- _getDriverName() : string
- Return the classname of the driver to load.
Properties
$_alarm
A Horde_Alarm instance.
protected
Horde_Alarm
$_alarm
$_injector
The injector.
protected
Horde_Injector
$_injector
$_ttl
TTL value.
protected
int
$_ttl
Methods
__construct()
Constructor.
public
__construct(Horde_Injector $injector) : mixed
Parameters
- $injector : Horde_Injector
-
The injector to use.
create()
Return a Horde_Alarm instance.
public
create() : Horde_Alarm
Tags
Return values
Horde_Alarmload()
Retrieves active alarms from all applications and stores them in the backend.
public
load([string $user = null ][, bool $preload = true ]) : mixed
The applications will only be called once in the configured time span, by default 5 minutes.
Parameters
- $user : string = null
-
Retrieve alarms for this user, or for all users if null.
- $preload : bool = true
-
Preload alarms that go off within the next ttl time span?
_getDriverName()
Return the classname of the driver to load.
protected
_getDriverName(string $driver, string $base) : string
Parameters
- $driver : string
-
Driver name.
- $base : string
-
The base classname.
Tags
Return values
string —Classname.