Class: I2CE Process: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: I2CE Process (4.1.7))
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class '''I2CE_Process'''
#REDIRECT [[Class: I2CE_Process (4.1.7)]]
It is contained in the module [[iHRIS Module List#I2CE|I2CE]] 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/annotate/head:/lib/I2CE_Process.php lib/I2CE_Process.php]
 
Handles processes.
 
@package I2CE
==Variables==
===$cmd===
The command being executed.
*Type: private ng $cmd
 
===$res===
Currently executing resource
*Type: private ng $res
 
===$pipes===
Stdin, Stdout, etc.
*Type: private y $pipes
 
===$exit===
holds the exit code of the program
*Type: private nteger $exit
 
===$done===
Flag so that we only execute this once.
*Type: private n $done
 
==Methods==
===__construct()===
Constructor for the I2CE_Process
@params string $cmd The full command line to execute.
*Signature: public function __construct($cmd)
Parameters:
*$cmd
===is_error()===
Returns a boolean indicating if an error code occurred. Will
run the Process if it hasn't been run.
*Signature: public function is_error()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] TRUE if an error occurred.
===slurp()===
Slurp up the output of the process
@params string $cmd The full command line to execute.
@todo implement stdin
*Signature: private function slurp()
===stderr()===
Provides access to what the command spewed out on STDERR
*Signature: public function stderr()
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
===stdout()===
Provides access to what the command spewed out on STDOUT
*Signature: public function stdout()
*Returns: [http://www.php.net/manual/en/language.types.string.php string] The output.
 
 
[[Category:Class Documentation]]

Latest revision as of 08:49, 23 August 2013