ProcessBuilder
class ProcessBuilder
Построитель процесса.
Методы
| __construct(array $arguments = array()) Конструктор. | ||
| static ProcessBuilder | create(array $arguments = array()) Создаёт экземпляр построителя процесса. | |
| $this | add(string $argument) Добавляет неэкранированный аргумент к строке команды. | |
| $this | setPrefix(string|array $prefix) Добавляет префикс к строке команды. | |
| $this | setArguments(array $arguments) Устанавливает аргументы процесса. | |
| $this | setWorkingDirectory(null|string $cwd) Устанавливает рабочую директорию. | |
| $this | inheritEnvironmentVariables(bool $inheritEnv = true) Устанавливает, будут ли унаследованы переменные окружения. | |
| $this | setEnv(string $name, null|string $value) Устанавливает переменную окружения. | |
| $this | addEnvironmentVariables(array $variables) Добавляет набор переменных окружения. | |
| $this | setInput(resource|scalar|Traversable|null $input) Устанавливает входные данные процесса. | |
| $this | setTimeout(float|null $timeout) Устанавливает таймаут процесса. | |
| $this | setOption(string $name, string $value) Добавляет опцию proc_open. | |
| $this | disableOutput() Отключает получение вывода и ошибок от процесса. | |
| $this | enableOutput() Включает получение вывода и ошибок от процесса. | |
| Process | getProcess() Создаёт экземпляр Process и возвращает его. |
Подробности
__construct(array $arguments = array())
Конструктор.
Параметры
| array | $arguments | Массив аргументов |
static ProcessBuilder create(array $arguments = array())
Создаёт экземпляр построителя процесса.
Параметры
| array | $arguments | Массив аргументов |
Возвращаемое значение
| ProcessBuilder |
$this add(string $argument)
Добавляет неэкранированный аргумент к строке команды.
Параметры
| string | $argument | Аргумент команды |
Возвращаемое значение
| $this |
$this setPrefix(string|array $prefix)
Добавляет префикс к строке команды.
Префикс сохраняется при сбросе аргументов.
Параметры
| string|array | $prefix | Префикс команды или массив префиксов команд |
Возвращаемое значение
| $this |
$this setArguments(array $arguments)
Устанавливает аргументы процесса.
Аргументы не должны быть экранированы. Предыдущие аргументы удаляются.
Параметры
| array | $arguments |
Возвращаемое значение
| $this |
$this setWorkingDirectory(null|string $cwd)
Устанавливает рабочую директорию.
Параметры
| null|string | $cwd | Рабочая директория |
Возвращаемое значение
| $this |
$this inheritEnvironmentVariables(bool $inheritEnv = true)
Устанавливает, будут ли унаследованы переменные окружения.
Параметры
| bool | $inheritEnv |
Возвращаемое значение
| $this |
$this setEnv(string $name, null|string $value)
Устанавливает переменную окружения.
Установка переменной перезаписывает её предыдущее значение. Используйте null для удаления определённой переменной окружения.
Параметры
| string | $name | Имя переменной |
| null|string | $value | Значение переменной |
Возвращаемое значение
| $this |
$this addEnvironmentVariables(array $variables)
Добавляет набор переменных окружения.
Уже существующие переменные окружения с тем же именем будут перезаписаны новыми значениями, переданными в этот метод. Используйте null для удаления переменной.
Параметры
| array | $variables | Переменные |
Возвращаемое значение
| $this |
$this setInput(resource|scalar|Traversable|null $input)
Устанавливает входные данные процесса.
Параметры
| resource|scalar|Traversable|null | $input | Содержимое входных данных |
Возвращаемое значение
| $this |
Исключения
| InvalidArgumentException | В случае неверного аргумента |
$this setTimeout(float|null $timeout)
Устанавливает таймаут процесса.
Чтобы отключить таймаут, установите это значение в null.
Параметры
| float|null | $timeout |
Возвращаемое значение
| $this |
Исключения
| InvalidArgumentException |
$this setOption(string $name, string $value)
Добавляет опцию proc_open.
Параметры
| string | $name | Имя опции |
| string | $value | Значение опции |
Возвращаемое значение
| $this |
$this disableOutput()
Отключает получение вывода и ошибок от процесса.
Возвращаемое значение
| $this |
$this enableOutput()
Включает получение вывода и ошибок от процесса.
Возвращаемое значение
| $this |
Process getProcess()
Создаёт экземпляр Process и возвращает его.
Возвращаемое значение
| Process |
Исключения
| LogicException | В случае отсутствия аргументов |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Process/ProcessBuilder.html