СписокКоманд

__construct(string|null $name = null)

Конструктор.

Параметры

string|null

$name

Имя команды; передача null означает, что оно должно быть установлено в configure()

Исключения

LogicException

При пустом имени команды

ignoreValidationErrors()

Игнорирует ошибки проверки.

Это в основном полезно для команды help.

setApplication(Application $application = null)

Устанавливает экземпляр приложения для этой команды.

Параметры

Application

$application

Экземпляр Application

setHelperSet(HelperSet $helperSet)

Устанавливает набор помощников.

Параметры

HelperSet

$helperSet

Экземпляр HelperSet

HelperSet getHelperSet()

Получает набор помощников.

Значение возврата

HelperSet

Экземпляр HelperSet

Application getApplication()

Получает экземпляр приложения для этой команды.

Значение возврата

Application

Экземпляр Application

bool isEnabled()

Проверяет, включена ли команда в текущей среде.

Переопределите этот метод для проверки x или y и возврата false, если команда не может работать должным образом в текущих условиях.

Значение возврата

bool

int run(InputInterface $input, OutputInterface $output)

Выполняет команду.

Код для выполнения определен либо напрямую методом setCode(), либо путем переопределения метода execute() в подклассе.

Параметры

InputInterface	$input	Экземпляр InputInterface
OutputInterface	$output	Экземпляр OutputInterface

Значение возврата

int	Код выхода команды

Исключения

Exception

См. также

setCode()
execute()

Command setCode(callable $code)

Устанавливает код для выполнения при запуске этой команды.

Если используется этот метод, он переопределяет код, определенный в методе execute().

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

Значение возврата

Command

Текущий экземпляр

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

Объединяет определение приложения с определением команды.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

Объединять или нет аргументы определения приложения с аргументами определения команды

Command setDefinition(array|InputDefinition $definition)

Устанавливает массив экземпляров аргументов и опций.

Параметры

array|InputDefinition

$definition

Массив экземпляров аргументов и опций или экземпляр определения

Значение возврата

Command

Текущий экземпляр

InputDefinition getDefinition()

Получает InputDefinition, прикрепленный к этой команде.

Значение возврата

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

Возвращает InputDefinition, используемый для создания представлений этой команды.

Можно переопределить, чтобы предоставить исходное представление команды, когда оно в противном случае изменяется путем объединения с InputDefinition приложения.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Значение возврата

InputDefinition

Экземпляр InputDefinition

Command addArgument(string $name, int $mode = null, string $description = '', mixed $default = null)

Добавляет аргумент.

Параметры

string	$name	Имя аргумента
int	$mode	Режим аргумента: InputArgument::REQUIRED или InputArgument::OPTIONAL
string	$description	Текст описания
mixed	$default	Значение по умолчанию (только для режима InputArgument::OPTIONAL)

Значение возврата

Command

Текущий экземпляр

Command addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', mixed $default = null)

Добавляет опцию.

Параметры

string	$name	Имя опции
string	$shortcut	Сокращение (может быть null)
int	$mode	Режим опции: одно из констант InputOption::VALUE_*
string	$description	Текст описания
mixed	$default	Значение по умолчанию (должно быть null для InputOption::VALUE_NONE)

Значение возврата

Command

Текущий экземпляр

Command setName(string $name)

Устанавливает имя команды.

Этот метод может установить как имя пространства имен, так и имя, если вы разделите их двоеточием (:)

$command->setName('foo:bar');

Параметры

string

$name

Имя команды

Значение возврата

Command

Текущий экземпляр

Исключения

InvalidArgumentException

При некорректном имени

Command setProcessTitle(string $title)

Устанавливает заголовок процесса для команды.

Эта функция должна использоваться только при создании команды с длительным процессом, например, демона.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

string

$title

Заголовок процесса

Значение возврата

Command

Текущий экземпляр

string getName()

Возвращает имя команды.

Значение возврата

string

Имя команды

Command setDescription(string $description)

Устанавливает описание команды.

Параметры

string

$description

Описание команды

Значение возврата

Команда

Текущий экземпляр

string getDescription()

Возвращает описание команды.

Значение возврата

string

Описание команды

Команда setHelp(string $help)

Устанавливает справку для команды.

Параметры

string

$help

Справка для команды

Значение возврата

Команда

Текущий экземпляр

string getHelp()

Возвращает справку для команды.

Значение возврата

string

Справка для команды

string getProcessedHelp()

Возвращает обработанную справку для команды, заменяя шаблоны %command.name% и %command.full_name% на реальные значения динамически.

Значение возврата

string

Обработанная справка для команды

Команда setAliases(string[] $aliases)

Устанавливает псевдонимы для команды.

Параметры

string[]

$aliases

Массив псевдонимов для команды

Значение возврата

Команда

Текущий экземпляр

Исключения

Исключение неверного аргумента

При неверном псевдониме

array getAliases()

Возвращает псевдонимы для команды.

Значение возврата

array

Массив псевдонимов для команды

string getSynopsis(bool $short = false)

Возвращает синтаксис для команды.

Параметры

bool

$short

Показывать короткую версию синтаксиса (с опциями сложенными) или нет

Значение возврата

string

Синтаксис

addUsage(string $usage)

Добавить пример использования команды.

Параметры

string

$usage

Использование, оно будет добавлено перед именем команды

array getUsages()

Возвращает альтернативные способы использования команды.

Значение возврата

array

mixed getHelper(string $name)

Получает экземпляр помощника по имени.

Параметры

string

$name

Имя помощника

Значение возврата

mixed

Значение помощника

Исключения

Логическая ошибка	если не определен HelperSet
Исключение неверного аргумента	если помощник не определен