Class: I2CE BackgroundProcess: Difference between revisions

From IHRIS Wiki
(Created page with 'This article desrcibes the class '''I2CE_BackgroundProcess'''which extends the class I2CE_Module It is contained in the module [[Module List#BackgroundPr…')
 
 
(31 intermediate revisions by one other user not shown)
Line 1: Line 1:
This article desrcibes the class '''I2CE_BackgroundProcess'''which extends the class [[Class: I2CE_Module | I2CE_Module]]
#REDIRECT [[Class: I2CE_BackgroundProcess (4.1.12)]]
It is contained in the module [[Module List#BackgroundProcess|BackgroundProcess]] in the package [https://launchpad.net/i2ce I2CE]
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/BackgroundProcess/I2CE_BackgroundProcess.php modules/BackgroundProcess/I2CE_BackgroundProcess.php]
I2CE_BackgroundProcess
@package I2CE
@subpackage Core
@author Carl Leitner <litlfred@ibiblio.org>
@version 2.1
@access public
==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 Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
===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