Class backgroundScript

Description

background script abstract class

PHP-CLI script which runs in the background

Located in /automne/classes/scripts/backgroundScript/backgroundscript.php (line 29)

CMS_grandFather
   |
   --backgroundScript
Direct descendents
Class Description
 class automne_script background script abstract class
Variable Summary
Method Summary
 void backgroundScript ([boolean $debug = false], [ $scriptID = 'Master'])
 void activate ()
Variables
boolean $_debug (line 43)

Is it debug-time ?

  • access: private
processManager $_processManager (line 36)

The process manager

  • access: private
Methods
Constructor backgroundScript (line 56)

Constructor.

Initializes the process manager and lauches the action if all went well, then delete the PIDFile NOTE : SCRIPT_CODENAME is a constant that must be defined, and unique accross all usage of the background scripts (i.e. One background script for one application should have the same, but two applications having the same script shouldn't collate)

  • access: public
void backgroundScript ([boolean $debug = false], [ $scriptID = 'Master'])
  • boolean $debug: Set to true if you want a debug of what the script does
  • $scriptID
activate (line 112)

activates the script function.

  • access: public
void activate ()

Redefined in descendants as:

Inherited Methods

Inherited From CMS_grandFather

 CMS_grandFather::autoload()
 CMS_grandFather::hasError()
 CMS_grandFather::log()
 CMS_grandFather::PHPErrorHandler()
 CMS_grandFather::raiseError()
 CMS_grandFather::setDebug()
 CMS_grandFather::setLog()
 CMS_grandFather::_raiseError()
 CMS_grandFather::__call()
Class Constants

Documentation generated on Wed, 15 Feb 2012 15:28:32 +0100 by phpDocumentor 1.4.3