Symfony\Component\Process\ProcessBuilder

class ProcessBuilder

Methods

	__construct(array $arguments = array()) Constructor
static ProcessBuilder	create(array $arguments = array()) Creates a process builder instance.
ProcessBuilder	add(string $argument) Adds an unescaped argument to the command string.
ProcessBuilder	setPrefix(string|array $prefix) Adds an unescaped prefix to the command string.
ProcessBuilder	setArguments(array $arguments) Sets the arguments of the process.
ProcessBuilder	setWorkingDirectory(null|string $cwd) Sets the working directory.
ProcessBuilder	inheritEnvironmentVariables(bool $inheritEnv = true) Sets whether environment variables will be inherited or not.
ProcessBuilder	setEnv(string $name, null|string $value) Sets an environment variable
ProcessBuilder	addEnvironmentVariables(array $variables) Adds a set of environment variables.
ProcessBuilder	setInput(string|null $input) Sets the input of the process.
ProcessBuilder	setTimeout(float|null $timeout) Sets the process timeout.
ProcessBuilder	setOption(string $name, string $value) Adds a proc_open option.
ProcessBuilder	disableOutput() Disables fetching output and error output from the underlying process.
ProcessBuilder	enableOutput() Enables fetching output and error output from the underlying process.
Process	getProcess() Creates a Process instance and returns it.

Details

public __construct(array $arguments = array())

Constructor

static public ProcessBuilder create(array $arguments = array())

Creates a process builder instance.

public ProcessBuilder add(string $argument)

Adds an unescaped argument to the command string.

public ProcessBuilder setPrefix(string|array $prefix)

Adds an unescaped prefix to the command string.

The prefix is preserved when resetting arguments.

public ProcessBuilder setArguments(array $arguments)

Sets the arguments of the process.

Arguments must not be escaped. Previous arguments are removed.

public ProcessBuilder setWorkingDirectory(null|string $cwd)

Sets the working directory.

public ProcessBuilder inheritEnvironmentVariables(bool $inheritEnv = true)

Sets whether environment variables will be inherited or not.

public ProcessBuilder setEnv(string $name, null|string $value)

Sets an environment variable

Setting a variable overrides its previous value. Use null to unset a defined environment variable.

public ProcessBuilder addEnvironmentVariables(array $variables)

Adds a set of environment variables.

Already existing environment variables with the same name will be overridden by the new values passed to this method. Pass null to unset a variable.

public ProcessBuilder setInput(string|null $input)

Sets the input of the process.

Deprecation: As of Symfony 2.5, this method only accepts string values.

public ProcessBuilder setTimeout(float|null $timeout)

Sets the process timeout.

To disable the timeout, set this value to null.

public ProcessBuilder setOption(string $name, string $value)

Adds a proc_open option.

public ProcessBuilder disableOutput()

Disables fetching output and error output from the underlying process.

public ProcessBuilder enableOutput()

Enables fetching output and error output from the underlying process.

public Process getProcess()

Creates a Process instance and returns it.