Class

Symfony\Component\Process\Process

class Process

Process is a thin wrapper around proc_* functions to easily start independent PHP processes.

Constants

ERR

OUT

STATUS_READY

STATUS_STARTED

STATUS_TERMINATED

STDIN

STDOUT

STDERR

TIMEOUT_PRECISION

Properties

static array $exitCodes Exit codes translation table.

Methods

__construct(string $commandline, string|null $cwd = null, array $env = null, string|null $stdin = null, integer|float|null $timeout = 60, array $options = array())

Constructor.

__destruct()

__clone()

integer run(callable|null $callback = null)

Runs the process.

Process mustRun(callable|null $callback = null)

Runs the process.

Process start(callable|null $callback = null)

Starts the process and returns after sending the STDIN.

Process restart(callable|null $callback = null)

Restarts the process.

integer wait(callable|null $callback = null)

Waits for the process to terminate.

integer|null getPid()

Returns the Pid (process identifier), if applicable.

Process signal(integer $signal)

Sends a POSIX signal to the process.

Process disableOutput()

Disables fetching output and error output from the underlying process.

Process enableOutput()

Enables fetching output and error output from the underlying process.

Boolean isOutputDisabled()

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

string getOutput()

Returns the current output of the process (STDOUT).

string getIncrementalOutput()

Returns the output incrementally.

Process clearOutput()

Clears the process output.

string getErrorOutput()

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

string getIncrementalErrorOutput()

Returns the errorOutput incrementally.

Process clearErrorOutput()

Clears the process output.

null|integer getExitCode()

Returns the exit code returned by the process.

null|string getExitCodeText()

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

Boolean isSuccessful()

Checks if the process ended successfully.

Boolean hasBeenSignaled()

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

integer getTermSignal()

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

Boolean hasBeenStopped()

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

integer getStopSignal()

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

Boolean isRunning()

Checks if the process is currently running.

Boolean isStarted()

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

Boolean isTerminated()

Checks if the process is terminated.

string getStatus()

Gets the process status.

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

Stops the process.

addOutput(string $line)

Adds a line to the STDOUT stream.

addErrorOutput(string $line)

Adds a line to the STDERR stream.

string getCommandLine()

Gets the command line to be executed.

Process setCommandLine(string $commandline)

Sets the command line to be executed.

float|null getTimeout()

Gets the process timeout (max.

float|null getIdleTimeout()

Gets the process idle timeout (max.

Process setTimeout(integer|float|null $timeout)

Sets the process timeout (max.

Process setIdleTimeout(integer|float|null $timeout)

Sets the process idle timeout (max.

Process setTty(boolean $tty)

Enables or disables the TTY mode.

Boolean isTty()

Checks if the TTY mode is enabled.

Process setPty(Boolean $bool)

Sets PTY mode.

Boolean isPty()

Returns PTY state.

string|null getWorkingDirectory()

Gets the working directory.

Process setWorkingDirectory(string $cwd)

Sets the current working directory.

array getEnv()

Gets the environment variables.

Process setEnv(array $env)

Sets the environment variables.

string|null getStdin()

Gets the contents of STDIN.

Process setStdin(string|null $stdin)

Sets the contents of STDIN.

array getOptions()

Gets the options for proc_open.

Process setOptions(array $options)

Sets the options for proc_open.

Boolean getEnhanceWindowsCompatibility()

Gets whether or not Windows compatibility is enabled.

Process setEnhanceWindowsCompatibility(Boolean $enhance)

Sets whether or not Windows compatibility is enabled.

Boolean getEnhanceSigchildCompatibility()

Returns whether sigchild compatibility mode is activated or not.

Process setEnhanceSigchildCompatibility(Boolean $enhance)

Activates sigchild compatibility mode.

checkTimeout()

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

static Boolean isPtySupported()

Returns whether PTY is supported on the current operating system.

Details

at line 139
public __construct(string $commandline, string|null $cwd = null, array $env = null, string|null $stdin = null, integer|float|null $timeout = 60, array $options = array())

Constructor.

Parameters

string $commandline The command line to run
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 inherit
string|null $stdin The STDIN content
integer|float|null $timeout The timeout in seconds or null to disable
array $options An array of options for proc_open

Exceptions

RuntimeException When proc_open is not installed

at line 170
public __destruct()

at line 176
public __clone()

at line 202
public integer 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

integer 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

at line 219
public Process mustRun(callable|null $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|null $callback

Return Value

Process

at line 252
public Process start(callable|null $callback = null)

Starts the process and returns after sending the 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. If there is no callback passed, the wait() method can be called with true as a second parameter then the callback will get all data occurred in (and since) the start call.

Parameters

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

Return Value

Process The process itself

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

at line 312
public Process restart(callable|null $callback = null)

Restarts the process.

Be warned that the process is cloned before being started.

Parameters

callable|null $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()

at line 339
public integer wait(callable|null $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|null $callback A valid PHP callback

Return Value

integer 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

at line 373
public integer|null getPid()

Returns the Pid (process identifier), if applicable.

Return Value

integer|null The process id if running, null otherwise

Exceptions

RuntimeException In case --enable-sigchild is activated

at line 395
public Process signal(integer $signal)

Sends a POSIX signal to the process.

Parameters

integer $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
RuntimeException In case of failure

at line 409
public Process disableOutput()

Disables fetching output and error output from the underlying process.

Return Value

Process

Exceptions

RuntimeException In case the process is already running

at line 430
public Process enableOutput()

Enables fetching output and error output from the underlying process.

Return Value

Process

Exceptions

RuntimeException In case the process is already running

at line 446
public Boolean isOutputDisabled()

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

Return Value

Boolean

at line 461
public 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

at line 485
public 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

at line 502
public Process clearOutput()

Clears the process output.

Return Value

Process

at line 520
public 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

at line 545
public 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

at line 562
public Process clearErrorOutput()

Clears the process output.

Return Value

Process

at line 579
public null|integer getExitCode()

Returns the exit code returned by the process.

Return Value

null|integer 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

at line 603
public 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.

Exceptions

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

See also

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

at line 619
public Boolean isSuccessful()

Checks if the process ended successfully.

Return Value

Boolean true if the process ended successfully, false otherwise

at line 636
public Boolean hasBeenSignaled()

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

It always returns false on Windows.

Return Value

Boolean

Exceptions

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

at line 661
public integer 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

integer

Exceptions

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

at line 685
public Boolean hasBeenStopped()

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

It always returns false on Windows.

Return Value

Boolean

Exceptions

LogicException In case the process is not terminated

at line 705
public integer 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

integer

Exceptions

LogicException In case the process is not terminated

at line 719
public Boolean isRunning()

Checks if the process is currently running.

Return Value

Boolean true if the process is currently running, false otherwise

at line 735
public Boolean isStarted()

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

Return Value

Boolean true if status is ready, false otherwise

at line 745
public Boolean isTerminated()

Checks if the process is terminated.

Return Value

Boolean true if process is terminated, false otherwise

at line 759
public string getStatus()

Gets the process status.

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

Return Value

string The current process status

at line 776
public integer stop(integer|float $timeout = 10, integer $signal = null)

Stops the process.

Parameters

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

Return Value

integer The exit-code of the process

Exceptions

RuntimeException if the process got signaled

at line 815
public addOutput(string $line)

Adds a line to the STDOUT stream.

Parameters

string $line The line to append

at line 826
public addErrorOutput(string $line)

Adds a line to the STDERR stream.

Parameters

string $line The line to append

at line 837
public string getCommandLine()

Gets the command line to be executed.

Return Value

string The command to execute

at line 849
public 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

at line 861
public float|null getTimeout()

Gets the process timeout (max.

runtime).

Return Value

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

at line 871
public 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

at line 887
public Process setTimeout(integer|float|null $timeout)

Sets the process timeout (max.

runtime).

To disable the timeout, set this value to null.

Parameters

integer|float|null $timeout The timeout in seconds

Return Value

Process The current Process instance

Exceptions

InvalidArgumentException if the timeout is negative

at line 905
public Process setIdleTimeout(integer|float|null $timeout)

Sets the process idle timeout (max.

time since last output).

To disable the timeout, set this value to null.

Parameters

integer|float|null $timeout The timeout in seconds

Return Value

Process The current Process instance.

Exceptions

InvalidArgumentException if the timeout is negative

at line 923
public Process setTty(boolean $tty)

Enables or disables the TTY mode.

Parameters

boolean $tty True to enabled and false to disable

Return Value

Process The current Process instance

at line 935
public Boolean isTty()

Checks if the TTY mode is enabled.

Return Value

Boolean true if the TTY mode is enabled, false otherwise

at line 947
public Process setPty(Boolean $bool)

Sets PTY mode.

Parameters

Boolean $bool

Return Value

Process

at line 959
public Boolean isPty()

Returns PTY state.

Return Value

Boolean

at line 969
public string|null getWorkingDirectory()

Gets the working directory.

Return Value

string|null The current working directory or null on failure

at line 987
public Process setWorkingDirectory(string $cwd)

Sets the current working directory.

Parameters

string $cwd The new working directory

Return Value

Process The current Process instance

at line 999
public array getEnv()

Gets the environment variables.

Return Value

array The current environment variables

at line 1017
public 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

at line 1037
public string|null getStdin()

Gets the contents of STDIN.

Return Value

string|null The current contents

at line 1049
public Process setStdin(string|null $stdin)

Sets the contents of STDIN.

Parameters

string|null $stdin The new contents

Return Value

Process The current Process instance

at line 1061
public array getOptions()

Gets the options for proc_open.

Return Value

array The current options

at line 1073
public Process setOptions(array $options)

Sets the options for proc_open.

Parameters

array $options The new options

Return Value

Process The current Process instance

at line 1087
public Boolean getEnhanceWindowsCompatibility()

Gets whether or not Windows compatibility is enabled.

This is true by default.

Return Value

Boolean

at line 1099
public Process setEnhanceWindowsCompatibility(Boolean $enhance)

Sets whether or not Windows compatibility is enabled.

Parameters

Boolean $enhance

Return Value

Process The current Process instance

at line 1111
public Boolean getEnhanceSigchildCompatibility()

Returns whether sigchild compatibility mode is activated or not.

Return Value

Boolean

at line 1127
public Process setEnhanceSigchildCompatibility(Boolean $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

Boolean $enhance

Return Value

Process The current Process instance

at line 1142
public 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

at line 1166
static public Boolean isPtySupported()

Returns whether PTY is supported on the current operating system.

Return Value

Boolean