Class Symfony\Component\Process\Process

`implements`	`IteratorAggregate<string, string>`


					
	public

__construct(
	array $command,
	string|null $cwd = null,
	array|null $env = null,
	mixed $input = null,
	int|float|null $timeout = 60,
)

Parameters

`$command`	The command to run and its arguments listed as separate entries
`$cwd`	The working directory or null to use the working dir of the current PHP process
`$env`	The environment variables or null to use the same environment as the current PHP process
`$input`	The input as stream resource, scalar or \Traversable, or null for no input
`$timeout`	The timeout in seconds or null to disable

Throws

Symfony\Component\Process\Exception\LogicException

When proc_open is not installed

#


					
	public
					static

fromShellCommandline(
	string $command,
	string|null $cwd = null,
	array|null $env = null,
	mixed $input = null,
	int|float|null $timeout = 60,
): static

Creates a Process instance as a command-line to be run in a shell wrapper.

Command-lines are parsed by the shell of your OS (/bin/sh on Unix-like, cmd.exe on Windows.) This allows using e.g. pipes or conditional execution. In this mode, signals are sent to the shell wrapper and not to your commands.

In order to inject dynamic values into command-lines, we strongly recommend using placeholders. This will save escaping values, which is not portable nor secure anyway:

$process = Process::fromShellCommandline('my_command "${:MY_VAR}"'); $process->run(null, ['MY_VAR' => $theValue]);

Parameters

`$command`	The command line to pass to the shell of the OS
`$cwd`	The working directory or null to use the working dir of the current PHP process
`$env`	The environment variables or null to use the same environment as the current PHP process
`$input`	The input as stream resource, scalar or \Traversable, or null for no input
`$timeout`	The timeout in seconds or null to disable

Throws

Symfony\Component\Process\Exception\LogicException

When proc_open is not installed

#


					
	public

__sleep(): array

#


					
	public

__wakeup(): void

#


					
	public

__destruct()

#


					
	public

__clone()

#


					
	public

run(callable|null $callback = null, array $env = []): int

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

$callback

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

Returns

The exit status code

Throws

`Symfony\Component\Process\Exception\ProcessStartFailedException`	When process can't be launched
`Symfony\Component\Process\Exception\RuntimeException`	When process is already running
`Symfony\Component\Process\Exception\ProcessTimedOutException`	When process timed out
`Symfony\Component\Process\Exception\ProcessSignaledException`	When process stopped after receiving signal
`Symfony\Component\Process\Exception\LogicException`	In case a callback is provided and output has been disabled

#


					
	public

mustRun(?callable $callback = null, array $env = []): $this

Runs the process.

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

Throws

Symfony\Component\Process\Exception\ProcessFailedException

if the process didn't terminate successfully

#


					
	public

start(callable|null $callback = null, array $env = []): void

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

$callback

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

Throws

`Symfony\Component\Process\Exception\ProcessStartFailedException`	When process can't be launched
`Symfony\Component\Process\Exception\RuntimeException`	When process is already running
`Symfony\Component\Process\Exception\LogicException`	In case a callback is provided and output has been disabled

#


					
	public

restart(callable|null $callback = null, array $env = []): static

Restarts the process.

Be warned that the process is cloned before being started.

Parameters

$callback

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

Throws

`Symfony\Component\Process\Exception\ProcessStartFailedException`	When process can't be launched
`Symfony\Component\Process\Exception\RuntimeException`	When process is already running

#


					
	public

wait(callable|null $callback = null): int

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

$callback

A valid PHP callback

Returns

The exitcode of the process

Throws

`Symfony\Component\Process\Exception\ProcessTimedOutException`	When process timed out
`Symfony\Component\Process\Exception\ProcessSignaledException`	When process stopped after receiving signal
`Symfony\Component\Process\Exception\LogicException`	When process is not yet started

#


					
	public

waitUntil(callable $callback): bool

Waits until the callback returns true.

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.

Throws

`Symfony\Component\Process\Exception\RuntimeException`	When process timed out
`Symfony\Component\Process\Exception\LogicException`	When process is not yet started
`Symfony\Component\Process\Exception\ProcessTimedOutException`	In case the timeout was reached

#


					
	public

getPid(): int|null

Returns the Pid (process identifier), if applicable.

Returns

The process id if running, null otherwise

#


					
	public

signal(int $signal): $this

Sends a POSIX signal to the process.

Parameters

$signal

A valid POSIX signal (see https://php.net/pcntl.constants)

Throws

`Symfony\Component\Process\Exception\LogicException`	In case the process is not running
`Symfony\Component\Process\Exception\RuntimeException`	In case --enable-sigchild is activated and the process can't be killed
`Symfony\Component\Process\Exception\RuntimeException`	In case of failure

#


					
	public

disableOutput(): $this

Disables fetching output and error output from the underlying process.

Throws

`Symfony\Component\Process\Exception\RuntimeException`	In case the process is already running
`Symfony\Component\Process\Exception\LogicException`	if an idle timeout is set

#


					
	public

enableOutput(): $this

Enables fetching output and error output from the underlying process.

Throws

Symfony\Component\Process\Exception\RuntimeException

In case the process is already running

#


					
	public

isOutputDisabled(): bool

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

#


					
	public

getOutput(): string

Returns the current output of the process (STDOUT).

Throws

`Symfony\Component\Process\Exception\LogicException`	in case the output has been disabled
`Symfony\Component\Process\Exception\LogicException`	In case the process is not started

#


					
	public

getIncrementalOutput(): string

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.

Throws

`Symfony\Component\Process\Exception\LogicException`	in case the output has been disabled
`Symfony\Component\Process\Exception\LogicException`	In case the process is not started

#


					
	public

getIterator(int $flags = 0): Generator<string, string>

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

Parameters

$flags

A bit field of Process::ITER_* flags

Throws

`Symfony\Component\Process\Exception\LogicException`	in case the output has been disabled
`Symfony\Component\Process\Exception\LogicException`	In case the process is not started

Implements

IteratorAggregate::getIterator()

#


					
	public

clearOutput(): $this

Clears the process output.

#


					
	public

getErrorOutput(): string

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

Throws

`Symfony\Component\Process\Exception\LogicException`	in case the output has been disabled
`Symfony\Component\Process\Exception\LogicException`	In case the process is not started

#


					
	public

getIncrementalErrorOutput(): string

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.

Throws

`Symfony\Component\Process\Exception\LogicException`	in case the output has been disabled
`Symfony\Component\Process\Exception\LogicException`	In case the process is not started

#


					
	public

clearErrorOutput(): $this

Clears the process output.

#


					
	public

getExitCode(): int|null

Returns the exit code returned by the process.

Returns

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

#


					
	public

getExitCodeText(): string|null

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.

Returns

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

#


					
	public

isSuccessful(): bool

Checks if the process ended successfully.

#


					
	public

hasBeenSignaled(): bool

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

It always returns false on Windows.

Throws

Symfony\Component\Process\Exception\LogicException

In case the process is not terminated

#


					
	public

getTermSignal(): int

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

It is only meaningful if hasBeenSignaled() returns true.

Throws

`Symfony\Component\Process\Exception\RuntimeException`	In case --enable-sigchild is activated
`Symfony\Component\Process\Exception\LogicException`	In case the process is not terminated

#


					
	public

hasBeenStopped(): bool

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

It always returns false on Windows.

Throws

Symfony\Component\Process\Exception\LogicException

In case the process is not terminated

#


					
	public

getStopSignal(): int

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

It is only meaningful if hasBeenStopped() returns true.

Throws

Symfony\Component\Process\Exception\LogicException

In case the process is not terminated

#


					
	public

isRunning(): bool

Checks if the process is currently running.

#


					
	public

isStarted(): bool

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

#


					
	public

isTerminated(): bool

Checks if the process is terminated.

#


					
	public

getStatus(): string

Gets the process status.

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

#


					
	public

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

Stops the process.

Parameters

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

Returns

The exit-code of the process or null if it's not running

#


					
	public

getLastOutputTime(): ?float

Gets the last output time in seconds.

#


					
	public

getCommandLine(): string

Gets the command line to be executed.

#


					
	public

getTimeout(): ?float

Gets the process timeout in seconds (max. runtime).

#


					
	public

getIdleTimeout(): ?float

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

#


					
	public

setTimeout(?float $timeout): $this

Sets the process timeout (max. runtime) in seconds.

To disable the timeout, set this value to null.

Throws

Symfony\Component\Process\Exception\InvalidArgumentException

if the timeout is negative

#


					
	public

setIdleTimeout(?float $timeout): $this

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

To disable the timeout, set this value to null.

Throws

`Symfony\Component\Process\Exception\LogicException`	if the output is disabled
`Symfony\Component\Process\Exception\InvalidArgumentException`	if the timeout is negative

#


					
	public

setTty(bool $tty): $this

Enables or disables the TTY mode.

Throws

Symfony\Component\Process\Exception\RuntimeException

In case the TTY mode is not supported

#


					
	public

isTty(): bool

Checks if the TTY mode is enabled.

#


					
	public

setPty(bool $bool): $this

Sets PTY mode.

#


					
	public

isPty(): bool

Returns PTY state.

#


					
	public

getWorkingDirectory(): ?string

Gets the working directory.

#


					
	public

setWorkingDirectory(string $cwd): $this

Sets the current working directory.

#


					
	public

getEnv(): array

Gets the environment variables.

#


					
	public

setEnv(array<string|Stringable> $env): $this

Sets the environment variables.

Parameters

$env

The new environment variables

#


					
	public

getInput(): resource|string|Iterator|null

Gets the Process input.

#


					
	public

setInput(string|resource|Traversable|self|null $input): $this

Sets the input.

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

Parameters

$input

The content

Throws

Symfony\Component\Process\Exception\LogicException

In case the process is running

#


					
	public

checkTimeout(): void

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

Throws

Symfony\Component\Process\Exception\ProcessTimedOutException

In case the timeout was reached

#


					
	public

getStartTime(): float

Throws

Symfony\Component\Process\Exception\LogicException

in case process is not started

#


					
	public

setOptions(array $options): void

Defines options to pass to the underlying proc_open().

#


					
	public

setIgnoredSignals(array $signals): void

Defines a list of posix signals that will not be propagated to the process.

#


					
	public
					static

isTtySupported(): bool

Returns whether TTY is supported on the current operating system.

#


					
	public
					static

isPtySupported(): bool

Returns whether PTY is supported on the current operating system.

#


					
	protected

buildCallback(callable|null $callback = null): Closure

Builds up the callback used by wait().

The callbacks adds all occurred output to the specific buffer and calls the user callback (if present) with the received output.

Parameters

$callback

The user defined PHP callback

#


					
	protected

updateStatus(bool $blocking): void

Updates the status of the process, reads pipes.

Parameters

$blocking

Whether to use a blocking read call

#


					
	protected

isSigchildEnabled(): bool

Returns whether PHP has been compiled with the '--enable-sigchild' option or not.

#

Constants
`public`	`ERR = 'err'`	#
`public`	`OUT = 'out'`	#
`public`	`STATUS_READY = 'ready'`	#
`public`	`STATUS_STARTED = 'started'`	#
`public`	`STATUS_TERMINATED = 'terminated'`	#
`public`	`STDIN = 0`	#
`public`	`STDOUT = 1`	#
`public`	`STDERR = 2`	#
`public`	`TIMEOUT_PRECISION = 0.2`	#
`public`	`ITER_NON_BLOCKING = 1`	#
`public`	`ITER_KEEP_OUTPUT = 2`	#
`public`	`ITER_SKIP_OUT = 4`	#
`public`	`ITER_SKIP_ERR = 8`	#

Namespaces

Classes

Class Symfony\Component\Process\Process

Parameters

Throws

Parameters

Throws

Parameters

Returns

Throws

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Throws

Throws

Returns

Parameters

Throws

Throws

Throws

Throws

Throws

Parameters

Throws

Implements

Throws

Throws

Returns

Returns

Throws

Throws

Throws

Throws

Parameters

Returns

Throws

Throws

Throws

Parameters

Parameters

Throws

Throws

Throws

Parameters

Parameters