\Horde_Core_Factory_Alarm

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.

Summary

Methods
Properties
Constants
__construct()
create()
load()
No public properties found
No constants found
_getDriverName()
$_injector
$_alarm
$_ttl
N/A
No private methods found
No private properties found
N/A

Properties

$_injector

$_injector : \Horde_Injector

The injector.

Type

\Horde_Injector

$_alarm

$_alarm : \Horde_Alarm

A Horde_Alarm instance.

Type

\Horde_Alarm

$_ttl

$_ttl : integer

TTL value.

Type

integer

Methods

__construct()

__construct(\Horde_Injector  $injector) 

Constructor.

Parameters

\Horde_Injector $injector

The injector to use.

create()

create() : \Horde_Alarm

Return a Horde_Alarm instance.

Throws

\Horde_Exception

Returns

\Horde_Alarm

load()

load(string  $user = null, boolean  $preload = true) 

Retrieves active alarms from all applications and stores them in the backend.

The applications will only be called once in the configured time span, by default 5 minutes.

Parameters

string $user

Retrieve alarms for this user, or for all users if null.

boolean $preload

Preload alarms that go off within the next ttl time span?

_getDriverName()

_getDriverName(string  $driver, string  $base) : string

Return the classname of the driver to load.

Parameters

string $driver

Driver name.

string $base

The base classname.

Throws

\Horde_Exception

Returns

string —

Classname.