* This file is part of the Symfony package.
* (c) Fabien Potencier <fabien@symfony.com>
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
namespace Symfony\Component\Process;
@trigger_error(sprintf('The %s class is deprecated since Symfony 3.4 and will be removed in 4.0. Use the Process class instead.', ProcessBuilder::class), \E_USER_DEPRECATED);
use Symfony\Component\Process\Exception\InvalidArgumentException;
use Symfony\Component\Process\Exception\LogicException;
* @author Kris Wallsmith <kris@symfony.com>
* @deprecated since version 3.4, to be removed in 4.0. Use the Process class instead.
private $inheritEnv = true;
private $outputDisabled = false;
* @param string[] $arguments An array of arguments
public function __construct(array $arguments = [])
$this->arguments = $arguments;
* Creates a process builder instance.
* @param string[] $arguments An array of arguments
public static function create(array $arguments = [])
return new static($arguments);
* Adds an unescaped argument to the command string.
* @param string $argument A command argument
public function add($argument)
$this->arguments[] = $argument;
* Adds a prefix to the command string.
* The prefix is preserved when resetting arguments.
* @param string|array $prefix A command prefix or an array of command prefixes
public function setPrefix($prefix)
$this->prefix = \is_array($prefix) ? $prefix : [$prefix];
* Sets the arguments of the process.
* Arguments must not be escaped.
* Previous arguments are removed.
* @param string[] $arguments
public function setArguments(array $arguments)
$this->arguments = $arguments;
* Sets the working directory.
* @param string|null $cwd The working directory
public function setWorkingDirectory($cwd)
* Sets whether environment variables will be inherited or not.
* @param bool $inheritEnv
public function inheritEnvironmentVariables($inheritEnv = true)
$this->inheritEnv = $inheritEnv;
* Sets an environment variable.
* Setting a variable overrides its previous value. Use `null` to unset a
* defined environment variable.
* @param string $name The variable name
* @param string|null $value The variable value
public function setEnv($name, $value)
$this->env[$name] = $value;
* 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
* @param array $variables The variables
public function addEnvironmentVariables(array $variables)
$this->env = array_replace($this->env, $variables);
* Sets the input of the process.
* @param resource|string|int|float|bool|\Traversable|null $input The input content
* @throws InvalidArgumentException In case the argument is invalid
public function setInput($input)
$this->input = ProcessUtils::validateInput(__METHOD__, $input);
* Sets the process timeout.
* To disable the timeout, set this value to null.
* @param float|null $timeout
* @throws InvalidArgumentException
public function setTimeout($timeout)
$timeout = (float) $timeout;
throw new InvalidArgumentException('The timeout value must be a valid positive integer or float number.');
$this->timeout = $timeout;
* Adds a proc_open option.
* @param string $name The option name
* @param string $value The option value
public function setOption($name, $value)
$this->options[$name] = $value;
* Disables fetching output and error output from the underlying process.
public function disableOutput()
$this->outputDisabled = true;
* Enables fetching output and error output from the underlying process.
public function enableOutput()
$this->outputDisabled = false;
* Creates a Process instance and returns it.
* @throws LogicException In case no arguments have been provided
public function getProcess()
if (0 === \count($this->prefix) && 0 === \count($this->arguments)) {
throw new LogicException('You must add() command arguments before calling getProcess().');
$arguments = array_merge($this->prefix, $this->arguments);
$process = new Process($arguments, $this->cwd, $this->env, $this->input, $this->timeout, $this->options);
// to preserve the BC with symfony <3.3, we convert the array structure
// to a string structure to avoid the prefixing with the exec command
$process->setCommandLine($process->getCommandLine());
$process->inheritEnvironmentVariables();
if ($this->outputDisabled) {
$process->disableOutput();
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
