Class: I2CE BackgroundProcess: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the class '''I2CE_BackgroundProcess''' which extends the class [[Class: I2CE_Module | I2CE_Module]]
This article desrcibes the class '''I2CE_BackgroundProcess'''.
*Extends the class: [[Class: I2CE_Module | I2CE_Module]].
It is contained in the module [[iHRIS Module List#BackgroundProcess|BackgroundProcess]] in the package [https://launchpad.net/i2ce I2CE]
It is contained in the module [[iHRIS Module List#BackgroundProcess|BackgroundProcess]] in the package [https://launchpad.net/i2ce I2CE]


Line 17: Line 18:
*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==

Revision as of 22:24, 16 October 2009

This article desrcibes the class I2CE_BackgroundProcess.

It is contained in the module BackgroundProcess in the package I2CE

The class is defined in the file: modules/BackgroundProcess/I2CE_BackgroundProcess.php

I2CE_BackgroundProcess @subpackage Core

  • Author: Carl Leitner <litlfred@ibiblio.org>

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:

  • 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()

  • Signature: static public function launchBackgroundPage($obj,$page,$cl_args)

Parameters:

  • mixed $obj
    Calling object
  • string $page
    the name of the page to launch
  • mixed $cl_args
    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:

  • mixed $obj
    The calling object
  • string $cmd
    The command
  • 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

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()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_BackgroundProcess&oldid=6474"