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