ProcessBuilder

class ProcessBuilder

Process builder.

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 a 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(resource\|scalar\|Traversable\|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

__construct(array $arguments = array())

Constructor.

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

ProcessBuilder add(string $argument)

Adds an unescaped argument to the command string.

Parameters

string

$argument

A command argument

Return Value

ProcessBuilder

ProcessBuilder 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

ProcessBuilder

ProcessBuilder setArguments(array $arguments)

Sets the arguments of the process.

Arguments must not be escaped. Previous arguments are removed.

Parameters

array

$arguments

Return Value

ProcessBuilder

ProcessBuilder setWorkingDirectory(null|string $cwd)

Sets the working directory.

Parameters

null|string

$cwd

The working directory

Return Value

ProcessBuilder

ProcessBuilder inheritEnvironmentVariables(bool $inheritEnv = true)

Sets whether environment variables will be inherited or not.

Parameters

bool

$inheritEnv

Return Value

ProcessBuilder

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.

Parameters

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

Return Value

ProcessBuilder

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.