ListCommand

__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

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

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

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

Возвращаемое значение

Команда

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

строка getDescription()

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

Значение результата

строка

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

Команда setHelp(строка $help)

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

Параметры

строка

$help

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

Значение результата

Команда

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

строка getHelp()

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

Значение результата

строка

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

строка getProcessedHelp()

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

Значение результата

строка

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

Команда setAliases(строка[] $aliases)

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

Параметры

строка[]

$aliases

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

Значение результата

Команда

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

Исключения

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

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

массив getAliases()

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

Значение результата

массив

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

строка getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

Значение результата

строка

Синтаксис

addUsage(строка $usage)

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

Параметры

строка

$usage

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

массив getUsages()

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

Значение результата

массив

смешанное getHelper(строка $name)

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

Параметры

строка

$name

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

Значение результата

смешанное

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

Исключения

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