Class Horde_Scheduler

Description

Horde_Scheduler

$Horde: framework/Scheduler/lib/Horde/Scheduler.php,v 1.1.2.1 2007/12/20 13:49:37 jan Exp $

Located in /Scheduler/lib/Horde/Scheduler.php (line 13)


	
			
Direct descendents
Class Description
 class Horde_Scheduler_cron Horde_Scheduler_cron:: Sort of a cron replacement in a PHP cli script.
Variable Summary
 string $_sleep
 integer $_sleep_adj
Method Summary
 Horde_Scheduler Horde_Scheduler ()
 Horde_Scheduler factory (string $driver, [array $params = null])
 void run ()
 void serialize ([string $id = ''])
 void sleep (integer $msec)
 void &unserialize (string $class, [string $id = ''], [boolean $autosave = true])
Variables
string $_sleep (line 20)

Name of the sleep function.

integer $_sleep_adj (line 27)

Adjustment factor to sleep in microseconds.

Methods
Constructor Horde_Scheduler (line 35)

Constructor.

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

Horde_Scheduler Horde_Scheduler ()
factory (line 147)

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

  • return: The newly created concrete Horde_Scheduler instance, or an error object.
Horde_Scheduler factory (string $driver, [array $params = null])
  • string $driver: The type of concrete Horde_Scheduler subclass to return.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
run (line 51)

Main loop/action function.

  • abstract:
void run ()

Redefined in descendants as:
serialize (line 66)

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.

void serialize ([string $id = ''])
  • string $id: An id to uniquely identify this scheduler from others of the same class.
sleep (line 131)

Platform-independant sleep $msec microseconds.

void sleep (integer $msec)
  • integer $msec: Microseconds to sleep.
unserialize (line 95)

Restore a Horde_Scheduler object from the cache.

void &unserialize (string $class, [string $id = ''], [boolean $autosave = true])
  • string $class: The name of the Horde_Scheduler object to restore.
  • string $id: An id to uniquely identify this scheduler from others of the same class.
  • boolean $autosave: Automatically store (serialize) the returned object at script shutdown.

Documentation generated on Sun, 30 Jan 2011 05:21:07 +0000 by phpDocumentor 1.4.3