Edit
In Place Editing Advanced Editing

PhpProcess

class PhpProcess extends Process

PhpProcess runs a PHP script in an independent process.

$p = new PhpProcess('<?php echo "foo"; ?>'); $p->run(); print $p->getOutput()."\n";

Constants

ERR
OUT
STATUS_READY
STATUS_STARTED
STATUS_TERMINATED
STDIN
STDOUT
STDERR
TIMEOUT_PRECISION
ITER_NON_BLOCKING
ITER_KEEP_OUTPUT
ITER_SKIP_OUT
ITER_SKIP_ERR

Properties

static array $exitCodes Exit codes translation table. from Process

Methods

__construct(string $script, string|null $cwd = null, array $env = null, int|float|null $timeout = 60, array $options = array())

Constructor.
__destruct() from Process
__clone() from Process
int run(callable|null $callback = null)

Runs the process.

 from Process
Process mustRun(callable $callback = null)

Runs the process.

 from Process
start(callable $callback = null)

Starts the process and returns after writing the input to STDIN.
Process restart(callable $callback = null)

Restarts the process.

 from Process
int wait(callable $callback = null)

Waits for the process to terminate.

 from Process
int|null getPid()

Returns the Pid (process identifier), if applicable.

 from Process
Process signal(int $signal)

Sends a POSIX signal to the process.

 from Process
Process disableOutput()

Disables fetching output and error output from the underlying process.

 from Process
Process enableOutput()

Enables fetching output and error output from the underlying process.

 from Process
bool isOutputDisabled()

Returns true in case the output is disabled, false otherwise.

 from Process
string getOutput()

Returns the current output of the process (STDOUT).

 from Process
string getIncrementalOutput()

Returns the output incrementally.

 from Process
Generator getIterator(int $flags)

Returns an iterator to the output of the process, with the output type as keys (Process::OUT/ERR).

 from Process
Process clearOutput()

Clears the process output.

 from Process
string getErrorOutput()

Returns the current error output of the process (STDERR).

 from Process
string getIncrementalErrorOutput()

Returns the errorOutput incrementally.

 from Process
Process clearErrorOutput()

Clears the process output.

 from Process
null|int getExitCode()

Returns the exit code returned by the process.

 from Process
null|string getExitCodeText()

Returns a string representation for the exit code returned by the process.

 from Process
bool isSuccessful()

Checks if the process ended successfully.

 from Process
bool hasBeenSignaled()

Returns true if the child process has been terminated by an uncaught signal.

 from Process
int getTermSignal()

Returns the number of the signal that caused the child process to terminate its execution.

 from Process
bool hasBeenStopped()

Returns true if the child process has been stopped by a signal.

 from Process
int getStopSignal()

Returns the number of the signal that caused the child process to stop its execution.

 from Process
bool isRunning()

Checks if the process is currently running.

 from Process
bool isStarted()

Checks if the process has been started with no regard to the current state.

 from Process
bool isTerminated()

Checks if the process is terminated.

 from Process
string getStatus()

Gets the process status.

 from Process
int stop(int|float $timeout = 10, int $signal = null)

Stops the process.

 from Process
addOutput(string $line)

Adds a line to the STDOUT stream.

 from Process
addErrorOutput(string $line)

Adds a line to the STDERR stream.

 from Process
string getCommandLine()

Gets the command line to be executed.

 from Process
Process setCommandLine(string $commandline)

Sets the command line to be executed.

 from Process
float|null getTimeout()

Gets the process timeout (max. runtime).

 from Process
float|null getIdleTimeout()

Gets the process idle timeout (max. time since last output).

 from Process
Process setTimeout(int|float|null $timeout)

Sets the process timeout (max. runtime).

 from Process
Process setIdleTimeout(int|float|null $timeout)

Sets the process idle timeout (max. time since last output).

 from Process
Process setTty(bool $tty)

Enables or disables the TTY mode.

 from Process
bool isTty()

Checks if the TTY mode is enabled.

 from Process
Process setPty(bool $bool)

Sets PTY mode.

 from Process
bool isPty()

Returns PTY state.

 from Process
string|null getWorkingDirectory()

Gets the working directory.

 from Process
Process setWorkingDirectory(string $cwd)

Sets the current working directory.

 from Process
array getEnv()

Gets the environment variables.

 from Process
Process setEnv(array $env)

Sets the environment variables.

 from Process
resource|string|Iterator|null getInput()

Gets the Process input.

 from Process
Process setInput(resource|scalar|Traversable|null $input)

Sets the input.

 from Process
array getOptions()

Gets the options for proc_open.

 from Process
Process setOptions(array $options)

Sets the options for proc_open.

 from Process
bool getEnhanceWindowsCompatibility()

Gets whether or not Windows compatibility is enabled.

 from Process
Process setEnhanceWindowsCompatibility(bool $enhance)

Sets whether or not Windows compatibility is enabled.

 from Process
bool getEnhanceSigchildCompatibility()

Returns whether sigchild compatibility mode is activated or not.

 from Process
Process setEnhanceSigchildCompatibility(bool $enhance)

Activates sigchild compatibility mode.

 from Process
checkTimeout()

Performs a check between the timeout definition and the time the process started.

 from Process
static bool isPtySupported()

Returns whether PTY is supported on the current operating system.

 from Process
setPhpBinary($php)

Sets the path to the PHP binary to use.

Details

__construct(string $script, string|null $cwd = null, array $env = null, int|float|null $timeout = 60, array $options = array())

Constructor.

Parameters

string $script The PHP script to run (as a string)
string|null $cwd The working directory or null to use the working dir of the current PHP process
array $env The environment variables or null to use the same environment as the current PHP process
int|float|null $timeout The timeout in seconds or null to disable
array $options An array of options for proc_open

__destruct()

__clone()

int run(callable|null $callback = null)

Runs the process.

The callback receives the type of output (out or err) and some bytes from the output in real-time. It allows to have feedback from the independent process during execution.

The STDOUT and STDERR are also available after the process is finished via the getOutput() and getErrorOutput() methods.

Parameters

callable|null $callback A PHP callback to run whenever there is some output available on STDOUT or STDERR

Return Value

int The exit status code

Exceptions

RuntimeException When process can't be launched
RuntimeException When process stopped after receiving signal
LogicException In case a callback is provided and output has been disabled

Process mustRun(callable $callback = null)

Runs the process.

This is identical to run() except that an exception is thrown if the process exits with a non-zero exit code.

Parameters

callable $callback

Return Value

Process

Exceptions

RuntimeException if PHP was compiled with --enable-sigchild and the enhanced sigchild compatibility mode is not enabled
ProcessFailedException if the process didn't terminate successfully

start(callable $callback = null)

Starts the process and returns after writing the input to STDIN.

This method blocks until all STDIN data is sent to the process then it returns while the process runs in the background.

The termination of the process can be awaited with wait().

The callback receives the type of output (out or err) and some bytes from the output in real-time while writing the standard input to the process. It allows to have feedback from the independent process during execution.

Parameters

callable $callback A PHP callback to run whenever there is some output available on STDOUT or STDERR

Exceptions

RuntimeException When process can't be launched
RuntimeException When process is already running
LogicException In case a callback is provided and output has been disabled

Process restart(callable $callback = null)

Restarts the process.

Be warned that the process is cloned before being started.

Parameters

callable $callback A PHP callback to run whenever there is some output available on STDOUT or STDERR

Return Value

Process The new process

Exceptions

RuntimeException When process can't be launched
RuntimeException When process is already running

See also

start()

int wait(callable $callback = null)

Waits for the process to terminate.

The callback receives the type of output (out or err) and some bytes from the output in real-time while writing the standard input to the process. It allows to have feedback from the independent process during execution.

Parameters

callable $callback A valid PHP callback

Return Value

int The exitcode of the process

Exceptions

RuntimeException When process timed out
RuntimeException When process stopped after receiving signal
LogicException When process is not yet started

int|null getPid()

Returns the Pid (process identifier), if applicable.

Return Value

int|null The process id if running, null otherwise

Process signal(int $signal)

Sends a POSIX signal to the process.

Parameters

int $signal A valid POSIX signal (see http://www.php.net/manual/en/pcntl.constants.php)

Return Value

Process

Exceptions

LogicException In case the process is not running
RuntimeException In case --enable-sigchild is activated and the process can't be killed
RuntimeException In case of failure

Process disableOutput()

Disables fetching output and error output from the underlying process.

Return Value

Process

Exceptions

RuntimeException In case the process is already running
LogicException if an idle timeout is set

Process enableOutput()

Enables fetching output and error output from the underlying process.

Return Value

Process

Exceptions

RuntimeException In case the process is already running

bool isOutputDisabled()

Returns true in case the output is disabled, false otherwise.

Return Value

bool

string getOutput()

Returns the current output of the process (STDOUT).

Return Value

string The process output

Exceptions

LogicException in case the output has been disabled
LogicException In case the process is not started

string getIncrementalOutput()

Returns the output incrementally.

In comparison with the getOutput method which always return the whole output, this one returns the new output since the last call.

Return Value

string The process output since the last call

Exceptions

LogicException in case the output has been disabled
LogicException In case the process is not started

Generator getIterator(int $flags)

Returns an iterator to the output of the process, with the output type as keys (Process::OUT/ERR).

Parameters

int $flags A bit field of Process::ITER_* flags.

Return Value

Generator

Exceptions

LogicException in case the output has been disabled
LogicException In case the process is not started

Process clearOutput()

Clears the process output.

Return Value

Process

string getErrorOutput()

Returns the current error output of the process (STDERR).

Return Value

string The process error output

Exceptions

LogicException in case the output has been disabled
LogicException In case the process is not started

string getIncrementalErrorOutput()

Returns the errorOutput incrementally.

In comparison with the getErrorOutput method which always return the whole error output, this one returns the new error output since the last call.

Return Value

string The process error output since the last call

Exceptions

LogicException in case the output has been disabled
LogicException In case the process is not started

Process clearErrorOutput()

Clears the process output.

Return Value

Process

null|int getExitCode()

Returns the exit code returned by the process.

Return Value

null|int The exit status code, null if the Process is not terminated

Exceptions

RuntimeException In case --enable-sigchild is activated and the sigchild compatibility mode is disabled

null|string getExitCodeText()

Returns a string representation for the exit code returned by the process.

This method relies on the Unix exit code status standardization and might not be relevant for other operating systems.

Return Value

null|string A string representation for the exit status code, null if the Process is not terminated.

See also

http://tldp.org/LDP/abs/html/exitcodes.html
http://en.wikipedia.org/wiki/Unix_signal

bool isSuccessful()

Checks if the process ended successfully.

Return Value

bool true if the process ended successfully, false otherwise

bool hasBeenSignaled()

Returns true if the child process has been terminated by an uncaught signal.

It always returns false on Windows.

Return Value

bool

Exceptions

RuntimeException In case --enable-sigchild is activated
LogicException In case the process is not terminated

int getTermSignal()

Returns the number of the signal that caused the child process to terminate its execution.

It is only meaningful if hasBeenSignaled() returns true.

Return Value

int

Exceptions

RuntimeException In case --enable-sigchild is activated
LogicException In case the process is not terminated

bool hasBeenStopped()

Returns true if the child process has been stopped by a signal.

It always returns false on Windows.

Return Value

bool

Exceptions

LogicException In case the process is not terminated

int getStopSignal()

Returns the number of the signal that caused the child process to stop its execution.

It is only meaningful if hasBeenStopped() returns true.

Return Value

int

Exceptions

LogicException In case the process is not terminated

bool isRunning()

Checks if the process is currently running.

Return Value

bool true if the process is currently running, false otherwise

bool isStarted()

Checks if the process has been started with no regard to the current state.

Return Value

bool true if status is ready, false otherwise

bool isTerminated()

Checks if the process is terminated.

Return Value

bool true if process is terminated, false otherwise

string getStatus()

Gets the process status.

The status is one of: ready, started, terminated.

Return Value

string The current process status

int stop(int|float $timeout = 10, int $signal = null)

Stops the process.

Parameters

int|float $timeout The timeout in seconds
int $signal A POSIX signal to send in case the process has not stop at timeout, default is SIGKILL (9)

Return Value

int The exit-code of the process

addOutput(string $line)

Adds a line to the STDOUT stream.

Parameters

string $line The line to append

addErrorOutput(string $line)

Adds a line to the STDERR stream.

Parameters

string $line The line to append

string getCommandLine()

Gets the command line to be executed.

Return Value

string The command to execute

Process setCommandLine(string $commandline)

Sets the command line to be executed.

Parameters

string $commandline The command to execute

Return Value

Process The current Process instance

float|null getTimeout()

Gets the process timeout (max. runtime).

Return Value

float|null The timeout in seconds or null if it's disabled

float|null getIdleTimeout()

Gets the process idle timeout (max. time since last output).

Return Value

float|null The timeout in seconds or null if it's disabled

Process setTimeout(int|float|null $timeout)

Sets the process timeout (max. runtime).

To disable the timeout, set this value to null.

Parameters

int|float|null $timeout The timeout in seconds

Return Value

Process The current Process instance

Exceptions

InvalidArgumentException if the timeout is negative

Process setIdleTimeout(int|float|null $timeout)

Sets the process idle timeout (max. time since last output).

To disable the timeout, set this value to null.

Parameters

int|float|null $timeout The timeout in seconds

Return Value

Process The current Process instance.

Exceptions

LogicException if the output is disabled
InvalidArgumentException if the timeout is negative

Process setTty(bool $tty)

Enables or disables the TTY mode.

Parameters

bool $tty True to enabled and false to disable

Return Value

Process The current Process instance

Exceptions

RuntimeException In case the TTY mode is not supported

bool isTty()

Checks if the TTY mode is enabled.

Return Value

bool true if the TTY mode is enabled, false otherwise

Process setPty(bool $bool)

Sets PTY mode.

Parameters

bool $bool

Return Value

Process

bool isPty()

Returns PTY state.

Return Value

bool

string|null getWorkingDirectory()

Gets the working directory.

Return Value

string|null The current working directory or null on failure

Process setWorkingDirectory(string $cwd)

Sets the current working directory.

Parameters

string $cwd The new working directory

Return Value

Process The current Process instance

array getEnv()

Gets the environment variables.

Return Value

array The current environment variables

Process setEnv(array $env)

Sets the environment variables.

An environment variable value should be a string. If it is an array, the variable is ignored.

That happens in PHP when 'argv' is registered into the $_ENV array for instance.

Parameters

array $env The new environment variables

Return Value

Process The current Process instance

resource|string|Iterator|null getInput()

Gets the Process input.

Return Value

resource|string|Iterator|null The Process input

Process setInput(resource|scalar|Traversable|null $input)

Sets the input.

This content will be passed to the underlying process standard input.

Parameters

resource|scalar|Traversable|null $input The content

Return Value

Process The current Process instance

Exceptions

LogicException In case the process is running

array getOptions()

Gets the options for proc_open.

Return Value

array The current options

Process setOptions(array $options)

Sets the options for proc_open.

Parameters

array $options The new options

Return Value

Process The current Process instance

bool getEnhanceWindowsCompatibility()

Gets whether or not Windows compatibility is enabled.

This is true by default.

Return Value

bool

Process setEnhanceWindowsCompatibility(bool $enhance)

Sets whether or not Windows compatibility is enabled.

Parameters

bool $enhance

Return Value

Process The current Process instance

bool getEnhanceSigchildCompatibility()

Returns whether sigchild compatibility mode is activated or not.

Return Value

bool

Process setEnhanceSigchildCompatibility(bool $enhance)

Activates sigchild compatibility mode.

Sigchild compatibility mode is required to get the exit code and determine the success of a process when PHP has been compiled with the --enable-sigchild option

Parameters

bool $enhance

Return Value

Process The current Process instance

checkTimeout()

Performs a check between the timeout definition and the time the process started.

In case you run a background process (with the start method), you should trigger this method regularly to ensure the process timeout

Exceptions

ProcessTimedOutException In case the timeout was reached

static bool isPtySupported()

Returns whether PTY is supported on the current operating system.

Return Value

bool

setPhpBinary($php)

Sets the path to the PHP binary to use.

Parameters

$php
doc_Symfony
doc_Symfony
2016-10-28 06:26:34
Comments
Leave a Comment

Please login to continue.