Class: I2CE BackgroundProcess: Difference between revisions

From IHRIS Wiki
No edit summary
 
(15 intermediate revisions by one other user not shown)
Line 1: Line 1:
This article describes the class ''I2CE_BackgroundProcess''.
#REDIRECT [[Class: I2CE_BackgroundProcess (4.1.12)]]
*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]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/BackgroundProcess/I2CE_BackgroundProcess.php modules/BackgroundProcess/I2CE_BackgroundProcess.php]
*Author: Carl Leitner <litlfred@ibiblio.org>
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
*Signature: static public function getLogDir()
===getMethods()===
*Signature: static public function getMethods()
===launchBackgroundPHPScript()===
*Signature: static public function launchBackgroundPHPScript($obj,$script,$cl_args,$wd)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj <br/>The calling object
** [http://www.php.net/manual/en/language.types.string.php string ] $script <br/>The php script
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $cl_args <br/>String or array of string, the command line arguments.  Defualts to empty arra.
***Default Value: array()
** [http://www.php.net/manual/en/language.types.string.php string ] $wd <br/>Workking directory.  Default to null
***Default Value: null
===launchBackgroundPage()===
*Signature: static public function launchBackgroundPage($obj,$page,$cl_args)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj <br/>Calling object
** [http://www.php.net/manual/en/language.types.string.php string ] $page <br/>the name of the page to launch
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $cl_args <br/>String or array of string, the command line arguments.  Defualts to empty arra.
***Default Value: array()
===launchBackgroundProcess()===
*Signature: static public function launchBackgroundProcess($obj,$cmd,$cl_args,$wd)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj <br/>The calling object
** [http://www.php.net/manual/en/language.types.string.php string ] $cmd <br/>The command
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $cl_args <br/>String or array of string, the command line arguments.  Defualts to empty arra.
***Default Value: array()
** [http://www.php.net/manual/en/language.types.string.php string ] $wd <br/>Workking directory.  Default to null
***Default Value: null
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
 
===action_configure()===
This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
 
===action_disable()===
This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
 
===action_enable()===
This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
 
===action_initialize()===
This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
 
===conflict_external()===
This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
 
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
 
===getCLIMethods()===
This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
 
===getConfig()===
This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
 
===getHooks()===
This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
 
===post_update()===
This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
 
===pre_upgrade()===
This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
 
===requirement_external()===
This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
 
===upgrade()===
This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 10:41, 18 August 2015