Overview

Packages

  • Scheduler

Classes

  • Horde_Scheduler
  • Horde_Scheduler_Cron
  • Horde_Scheduler_Cron_Date
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Scheduler

Horde_Scheduler

Direct known subclasses

Horde_Scheduler_Cron
Package: Scheduler
Located at Horde/Scheduler.php
Methods summary
public static Horde_Scheduler
# factory( string $driver, array $params = null )

Attempts to return a concrete Horde_Scheduler instance based on $driver.

Attempts to return a concrete Horde_Scheduler instance based on $driver.

Parameters

$driver
The type of concrete subclass to return.
$params
<p>A hash containing any additional configuration or connection parameters a subclass might need.</p>

Returns

Horde_Scheduler
The newly created concrete instance.

Throws

Horde_Scheduler_Exception
public
# __construct( )

Constructor.

Constructor.

Figures out how we can best sleep with microsecond precision based on what platform we're running on.

public
# run( )

Main loop/action function.

Main loop/action function.

public boolean
# serialize( string $id = '' )

Preserve the internal state of the scheduler object that we are passed, and save it to the Horde VFS backend. Horde_Scheduler objects should define __sleep() and __wakeup() serialization callbacks for anything that needs to be done at object serialization or deserialization - handling database connections, etc.

Preserve the internal state of the scheduler object that we are passed, and save it to the Horde VFS backend. Horde_Scheduler objects should define __sleep() and __wakeup() serialization callbacks for anything that needs to be done at object serialization or deserialization - handling database connections, etc.

Parameters

$id
<p>An id to uniquely identify this scheduler from others of the same class.</p>

Returns

boolean
Success result.
public
# unserialize( string $class, string $id = '', boolean $autosave = true )

Restore a Horde_Scheduler object from the cache.

Restore a Horde_Scheduler object from the cache.

Parameters

$class
The name of the object to restore.
$id
<p>An id to uniquely identify this scheduler from others of the same class.</p>
$autosave
<p>Automatically store (serialize) the returned object at script shutdown.</p>

See

Horde_Scheduler::serialize()
public
# sleep( integer $msec )

Platform-independant sleep $msec microseconds.

Platform-independant sleep $msec microseconds.

Parameters

$msec
Microseconds to sleep.
API documentation generated by ApiGen