Class: I2CE BackgroundProcess: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
*Location: Part of the module [[I2CE Module List#BackgroundProcess|BackgroundProcess]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#BackgroundProcess|BackgroundProcess]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php modules/BackgroundProcess/I2CE_BackgroundProcess.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php#L31 modules/BackgroundProcess/I2CE_BackgroundProcess.php] on line 31
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_BackgroundProcess
I2CE_BackgroundProcess
Line 8: Line 8:
===getLogDir()===
===getLogDir()===
Returns the log directory for background process.  It will attempt to create it if it is not there. @returnn mixed string the logDirectory or false on failure/inaccessable
Returns the log directory for background process.  It will attempt to create it if it is not there. @returnn mixed string the logDirectory or false on failure/inaccessable
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php#L118 i2ce/modules/BackgroundProcess/I2CE_BackgroundProcess.php] on line 118
*Signature: static public function getLogDir()
*Signature: static public function getLogDir()
===getMethods()===
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php#L36 i2ce/modules/BackgroundProcess/I2CE_BackgroundProcess.php] on line 36
*Signature: static public function getMethods()
*Signature: static public function getMethods()
===launchBackgroundPHPScript()===
===launchBackgroundPHPScript()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php#L145 i2ce/modules/BackgroundProcess/I2CE_BackgroundProcess.php] on line 145
*Signature: static public function launchBackgroundPHPScript($obj,$script,$cl_args,$wd)
*Signature: static public function launchBackgroundPHPScript($obj,$script,$cl_args,$wd)
*Parameters:
*Parameters:
Line 21: Line 24:
***Default Value: null
***Default Value: null
===launchBackgroundPage()===
===launchBackgroundPage()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php#L173 i2ce/modules/BackgroundProcess/I2CE_BackgroundProcess.php] on line 173
*Signature: static public function launchBackgroundPage($obj,$page,$cl_args)
*Signature: static public function launchBackgroundPage($obj,$page,$cl_args)
*Parameters:
*Parameters:
Line 28: Line 32:
***Default Value: array()
***Default Value: array()
===launchBackgroundProcess()===
===launchBackgroundProcess()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php#L55 i2ce/modules/BackgroundProcess/I2CE_BackgroundProcess.php] on line 55
*Signature: static public function launchBackgroundProcess($obj,$cmd,$cl_args,$wd)
*Signature: static public function launchBackgroundProcess($obj,$cmd,$cl_args,$wd)
*Parameters:
*Parameters:

Revision as of 08:48, 10 November 2009

This article describes the class I2CE_BackgroundProcess.

I2CE_BackgroundProcess

Methods

getLogDir()

Returns the log directory for background process. It will attempt to create it if it is not there. @returnn mixed string the logDirectory or false on failure/inaccessable

getMethods()

launchBackgroundPHPScript()

  • Defined in i2ce/modules/BackgroundProcess/I2CE_BackgroundProcess.php on line 145
  • Signature: static public function launchBackgroundPHPScript($obj,$script,$cl_args,$wd)
  • Parameters:
    • mixed $obj
      The calling object
    • string $script
      The php script
    • mixed $cl_args
      String or array of string, the command line arguments. Defualts to empty arra.
      • Default Value: array()
    • string $wd
      Workking directory. Default to null
      • Default Value: null

launchBackgroundPage()

launchBackgroundProcess()

Inherited Methods

__construct()

This public method is inherited from I2CE_Module->__construct()

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

conflict_external()

This public method is inherited from I2CE_Module->conflict_external()

getCLIHooks()

This public method is inherited from I2CE_Module->getCLIHooks()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

getHooks()

This public method is inherited from I2CE_Module->getHooks()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

requirement_external()

This public method is inherited from I2CE_Module->requirement_external()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()