ProcessBuilder

__construct(array $arguments = array())

Parameters

array

$arguments

An array of arguments

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

Creates a process builder instance.

Parameters

array

$arguments

An array of arguments

Return Value

ProcessBuilder

$this add(string $argument)

Adds an unescaped argument to the command string.

Parameters

string

$argument

A command argument

Return Value

$this

$this setPrefix(string|array $prefix)

Adds a prefix to the command string.

The prefix is preserved when resetting arguments.

Parameters

string|array

$prefix

A command prefix or an array of command prefixes

Return Value

$this

$this setArguments(array $arguments)

Sets the arguments of the process.

Arguments must not be escaped. Previous arguments are removed.

Parameters

array

$arguments

Return Value

$this

$this setWorkingDirectory(null|string $cwd)

Sets the working directory.

Parameters

null|string

$cwd

The working directory

Return Value

$this

$this inheritEnvironmentVariables(bool $inheritEnv = true) ^deprecated

^deprecated

since version 3.3, to be removed in 4.0.

Sets whether environment variables will be inherited or not.

Parameters

bool

$inheritEnv

Return Value

$this

$this 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.

Parameters

string	$name	The variable name
null|string	$value	The variable value

Return Value

$this

$this 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.

Parameters

array

$variables

The variables

Return Value

$this

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

Sets the input of the process.

Parameters

resource|scalar|Traversable|null

$input

The input content

Return Value

$this

Exceptions

InvalidArgumentException

In case the argument is invalid

$this setTimeout(float|null $timeout)

Sets the process timeout.

To disable the timeout, set this value to null.

Parameters

float|null

$timeout

Return Value

$this

Exceptions

InvalidArgumentException

$this setOption(string $name, string $value) ^deprecated

^deprecated

since version 3.3, to be removed in 4.0.

Adds a proc_open option.

Parameters

string	$name	The option name
string	$value	The option value

Return Value

$this

$this disableOutput()

Disables fetching output and error output from the underlying process.

Return Value

$this

$this enableOutput()

Enables fetching output and error output from the underlying process.

Return Value

$this

Process getProcess()

Creates a Process instance and returns it.

Return Value

Process

Exceptions

LogicException

In case no arguments have been provided