Symfony\Component\Process\ProcessBuilder Class Reference

Process builder. More...

Collaboration diagram for Symfony\Component\Process\ProcessBuilder:

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

Static Public Member Functions
static	create (array $arguments=array())
	Creates a process builder instance. More...

Private Attributes
	$arguments
	$cwd
	$env = array()
	$input
	$timeout = 60
	$options = array()
	$inheritEnv = true
	$prefix = array()
	$outputDisabled = false

Detailed Description

Process builder.

Author

Kris Wallsmith kris@.nosp@m.symf.nosp@m.ony.c.nosp@m.om

Definition at line 22 of file ProcessBuilder.php.

Constructor & Destructor Documentation

__construct()

Symfony\Component\Process\ProcessBuilder::__construct

(

array

$arguments = array()

)

Constructor.

Parameters

string[]

$arguments

An array of arguments

Definition at line 39 of file ProcessBuilder.php.

    {
        $this->arguments = $arguments;
    }

References Symfony\Component\Process\ProcessBuilder\$arguments.

Member Function Documentation

add()

Symfony\Component\Process\ProcessBuilder::add

(

$argument

)

Adds an unescaped argument to the command string.

Parameters

string

$argument

A command argument

Returns

ProcessBuilder

Definition at line 63 of file ProcessBuilder.php.

    {
        $this->arguments[] = $argument;
 
        return $this;
    }

addEnvironmentVariables()

Symfony\Component\Process\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.

Parameters

array

$variables

The variables

Returns

ProcessBuilder

Definition at line 160 of file ProcessBuilder.php.

    {
        $this->env = array_replace($this->env, $variables);
 
        return $this;
    }

create()

static Symfony\Component\Process\ProcessBuilder::create ( array  $arguments = array() )

static

Creates a process builder instance.

Parameters

string[]

$arguments

An array of arguments

Returns

ProcessBuilder

Definition at line 51 of file ProcessBuilder.php.

    {
        return new static($arguments);
    }

References Symfony\Component\Process\ProcessBuilder\$arguments.

Referenced by Symfony\Component\Process\Tests\ProcessBuilderTest\testInheritEnvironmentVars(), Symfony\Component\Process\Tests\ProcessBuilderTest\testInvalidInput(), Symfony\Component\Process\Tests\ProcessBuilderTest\testProcessShouldInheritAndOverrideEnvironmentVars(), Symfony\Component\Process\Tests\ProcessBuilderTest\testShouldNotThrowALogicExceptionIfNoArgument(), Symfony\Component\Process\Tests\ProcessBuilderTest\testShouldNotThrowALogicExceptionIfNoPrefix(), Symfony\Component\Process\Tests\ProcessBuilderTest\testShouldReturnProcessWithDisabledOutput(), Symfony\Component\Process\Tests\ProcessBuilderTest\testShouldReturnProcessWithEnabledOutput(), and Symfony\Component\Process\Tests\ProcessBuilderTest\testShouldThrowALogicExceptionIfNoPrefixAndNoArgument().

Here is the caller graph for this function:

disableOutput()

Symfony\Component\Process\ProcessBuilder::disableOutput

(

)

Disables fetching output and error output from the underlying process.

Returns

ProcessBuilder

Definition at line 233 of file ProcessBuilder.php.

    {
        $this->outputDisabled = true;
 
        return $this;
    }

enableOutput()

Symfony\Component\Process\ProcessBuilder::enableOutput

(

)

Enables fetching output and error output from the underlying process.

Returns

ProcessBuilder

Definition at line 245 of file ProcessBuilder.php.

    {
        $this->outputDisabled = false;
 
        return $this;
    }

getProcess()

Symfony\Component\Process\ProcessBuilder::getProcess

(

)

Creates a Process instance and returns it.

Returns

Process

Exceptions

LogicException

In case no arguments have been provided

Definition at line 259 of file ProcessBuilder.php.

    {
        if (0 === count($this->prefix) && 0 === count($this->arguments)) {
            throw new LogicException('You must add() command arguments before calling getProcess().');
        }
 
        $options = $this->options;
 
        $arguments = array_merge($this->prefix, $this->arguments);
        $script = implode(' ', array_map(array(__NAMESPACE__.'\\ProcessUtils', 'escapeArgument'), $arguments));
 
        if ($this->inheritEnv) {
            $env = array_replace($_ENV, $_SERVER, $this->env);
        } else {
            $env = $this->env;
        }
 
        $process = new Process($script, $this->cwd, $env, $this->input, $this->timeout, $options);
 
        if ($this->outputDisabled) {
            $process->disableOutput();
        }
 
        return $process;
    }

References $_SERVER, Symfony\Component\Process\ProcessBuilder\$arguments, Symfony\Component\Process\ProcessBuilder\$env, Symfony\Component\Process\ProcessBuilder\$options, and input.

inheritEnvironmentVariables()

Symfony\Component\Process\ProcessBuilder::inheritEnvironmentVariables

(

$inheritEnv = true

)

Sets whether environment variables will be inherited or not.

Parameters

bool

$inheritEnv

Returns

ProcessBuilder

Definition at line 124 of file ProcessBuilder.php.

    {
        $this->inheritEnv = $inheritEnv;
 
        return $this;
    }

References Symfony\Component\Process\ProcessBuilder\$inheritEnv.

setArguments()

Symfony\Component\Process\ProcessBuilder::setArguments

(

array

$arguments

)

Sets the arguments of the process.

Arguments must not be escaped. Previous arguments are removed.

Parameters

string[]

$arguments

Returns

ProcessBuilder

Definition at line 96 of file ProcessBuilder.php.

    {
        $this->arguments = $arguments;
 
        return $this;
    }

References Symfony\Component\Process\ProcessBuilder\$arguments.

setEnv()

Symfony\Component\Process\ProcessBuilder::setEnv	(		$name,
			$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

Returns

ProcessBuilder

Definition at line 142 of file ProcessBuilder.php.

    {
        $this->env[$name] = $value;
 
        return $this;
    }

Referenced by Assetic\Filter\BaseProcessFilter\mergeEnv().

Here is the caller graph for this function:

setInput()

Symfony\Component\Process\ProcessBuilder::setInput

(

$input

)

Sets the input of the process.

Parameters

resource | scalar | \Traversable | null

$input

The input content

Returns

ProcessBuilder

Exceptions

InvalidArgumentException

In case the argument is invalid

Definition at line 176 of file ProcessBuilder.php.

    {
        $this->input = ProcessUtils::validateInput(__METHOD__, $input);
 
        return $this;
    }

References Symfony\Component\Process\ProcessBuilder\$input, input, and Symfony\Component\Process\ProcessUtils\validateInput().

Here is the call graph for this function:

setOption()

Symfony\Component\Process\ProcessBuilder::setOption	(		$name,
			$value
	)

Adds a proc_open option.

Parameters

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

Returns

ProcessBuilder

Definition at line 221 of file ProcessBuilder.php.

    {
        $this->options[$name] = $value;
 
        return $this;
    }

setPrefix()

Symfony\Component\Process\ProcessBuilder::setPrefix

(

$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

Returns

ProcessBuilder

Definition at line 79 of file ProcessBuilder.php.

    {
        $this->prefix = is_array($prefix) ? $prefix : array($prefix);
 
        return $this;
    }

References Symfony\Component\Process\ProcessBuilder\$prefix.

setTimeout()

Symfony\Component\Process\ProcessBuilder::setTimeout

(

$timeout

)

Sets the process timeout.

To disable the timeout, set this value to null.

Parameters

float | null

$timeout

Returns

ProcessBuilder

Exceptions

InvalidArgumentException

Definition at line 194 of file ProcessBuilder.php.

    {
        if (null === $timeout) {
            $this->timeout = null;
 
            return $this;
        }
 
        $timeout = (float) $timeout;
 
        if ($timeout < 0) {
            throw new InvalidArgumentException('The timeout value must be a valid positive integer or float number.');
        }
 
        $this->timeout = $timeout;
 
        return $this;
    }

References Symfony\Component\Process\ProcessBuilder\$timeout.

setWorkingDirectory()

Symfony\Component\Process\ProcessBuilder::setWorkingDirectory

(

$cwd

)

Sets the working directory.

Parameters

null | string

$cwd

The working directory

Returns

ProcessBuilder

Definition at line 110 of file ProcessBuilder.php.

    {
        $this->cwd = $cwd;
 
        return $this;
    }

References Symfony\Component\Process\ProcessBuilder\$cwd.

Field Documentation

$arguments

Symfony\Component\Process\ProcessBuilder::$arguments

private

Definition at line 24 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\__construct(), Symfony\Component\Process\ProcessBuilder\create(), Symfony\Component\Process\ProcessBuilder\getProcess(), and Symfony\Component\Process\ProcessBuilder\setArguments().

$cwd

Symfony\Component\Process\ProcessBuilder::$cwd

private

Definition at line 25 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\setWorkingDirectory().

$env

Symfony\Component\Process\ProcessBuilder::$env = array()

private

Definition at line 26 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\getProcess().

$inheritEnv

Symfony\Component\Process\ProcessBuilder::$inheritEnv = true

private

Definition at line 30 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\inheritEnvironmentVariables().

$input

Symfony\Component\Process\ProcessBuilder::$input

private

Definition at line 27 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\setInput().

$options

Symfony\Component\Process\ProcessBuilder::$options = array()

private

Definition at line 29 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\getProcess().

$outputDisabled

Symfony\Component\Process\ProcessBuilder::$outputDisabled = false

private

Definition at line 32 of file ProcessBuilder.php.

$prefix

Symfony\Component\Process\ProcessBuilder::$prefix = array()

private

Definition at line 31 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\setPrefix().

$timeout

Symfony\Component\Process\ProcessBuilder::$timeout = 60

private

Definition at line 28 of file ProcessBuilder.php.

Referenced by Symfony\Component\Process\ProcessBuilder\setTimeout().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/symfony/process/ProcessBuilder.php