Class: I2CE BackgroundProcess: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
==Methods== | ==Methods== | ||
===getLogDir()=== | ===getLogDir()=== | ||
Returns the log directory for background process. It will attempt to create it if it is not there. | 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 | ||
@returnn mixed string the logDirectory or false on failure/inaccessable | |||
*Signature: static public function getLogDir() | *Signature: static public function getLogDir() | ||
===getMethods()=== | ===getMethods()=== | ||
| Line 14: | Line 13: | ||
===launchBackgroundPHPScript()=== | ===launchBackgroundPHPScript()=== | ||
*Signature: static public function launchBackgroundPHPScript($obj,$script,$cl_args,$wd) | *Signature: static public function launchBackgroundPHPScript($obj,$script,$cl_args,$wd) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj<br/>The calling object | ** [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.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. | ** [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() | ***Default Value: array() | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $wd<br/>Workking directory. Default to null | ** [http://www.php.net/manual/en/language.types.string.php string ] $wd <br/>Workking directory. Default to null | ||
**Default Value: null | ***Default Value: null | ||
===launchBackgroundPage()=== | ===launchBackgroundPage()=== | ||
*Signature: static public function launchBackgroundPage($obj,$page,$cl_args) | *Signature: static public function launchBackgroundPage($obj,$page,$cl_args) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj<br/>Calling object | ** [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.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. | ** [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() | ***Default Value: array() | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
*Signature: static public function launchBackgroundProcess($obj,$cmd,$cl_args,$wd) | *Signature: static public function launchBackgroundProcess($obj,$cmd,$cl_args,$wd) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $obj<br/>The calling object | ** [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.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. | ** [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() | ***Default Value: array() | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $wd<br/>Workking directory. Default to null | ** [http://www.php.net/manual/en/language.types.string.php string ] $wd <br/>Workking directory. Default to null | ||
**Default Value: null | ***Default Value: null | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
Revision as of 22:39, 16 October 2009
This article desrcibes the class I2CE_BackgroundProcess.
- Extends the class: I2CE_Module.
- Location: Part of the module BackgroundProcess in the package I2CE
- Source: Defined in the file 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:
launchBackgroundPage()
- Signature: static public function launchBackgroundPage($obj,$page,$cl_args)
- Parameters:
launchBackgroundProcess()
- Signature: static public function launchBackgroundProcess($obj,$cmd,$cl_args,$wd)
- Parameters:
Inherited Fuzzy Methods
launchBackgroundProcess()
This method is inherited from I2CE_Module->launchBackgroundProcess()
launchBackgroundPHPScript()
This method is inherited from I2CE_Module->launchBackgroundPHPScript()
launchBackgroundPage()
This method is inherited from I2CE_Module->launchBackgroundPage()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
