ListCommand

static строка|null getDefaultName()

Значение возвращаемого значения

строка|null

Имя команды по умолчанию или null, если имя по умолчанию не задано

__construct(строка $name = null)

Параметры

строка

$name

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

Исключения

LogicException

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

ignoreValidationErrors()

Игнорирует ошибки валидации.

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

setApplication(Приложение $application = null)

Параметры

Приложение

$application

setHelperSet(Набор помощников $helperSet)

Параметры

Набор помощников

$helperSet

Набор помощников getHelperSet()

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

Значение возвращаемого значения

Набор помощников

Экземпляр HelperSet

Приложение getApplication()

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

Значение возвращаемого значения

Приложение

Экземпляр Application

bool isEnabled()

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

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

Значение возвращаемого значения

bool

protected configure()

Настраивает текущую команду.

protected целое число|null execute(InputInterface $input, OutputInterface $output)

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

Этот метод не является абстрактным, потому что вы можете использовать этот класс как конкретный класс. В этом случае, вместо определения метода execute(), вы задаете код для выполнения, передав лямбда-выражение методу setCode().

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

целое число|null

null или 0, если всё прошло хорошо, или код ошибки

Исключения

LogicException

Если этот абстрактный метод не реализован

protected interact(InputInterface $input, OutputInterface $output)

Взаимодействует с пользователем.

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

Параметры

InputInterface	$input
OutputInterface	$output

protected initialize(InputInterface $input, OutputInterface $output)

Инициализирует команду после привязки ввода и перед проверкой ввода.

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

Параметры

InputInterface	$input
OutputInterface	$output

См. также

InputInterface::bind
InputInterface::validate

целое число run(InputInterface $input, OutputInterface $output)

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

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

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

целое число

Код завершения команды

Исключения

Исключение

При сбое привязки ввода. Можно обойти это, вызвав {@link ignoreValidationErrors()}.

См. также

setCode()
execute()

$this setCode(вызываемый $code)

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

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

Параметры

вызываемый

$code

Вызываемый callable(InputInterface $input, OutputInterface $output)

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

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

Параметры

bool

$mergeArgs

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

$this setDefinition(массив|InputDefinition $definition)

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

Параметры

массив|InputDefinition

$definition

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

Значение возвращаемого значения

$this

InputDefinition getDefinition()

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

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

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

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

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

$this addArgument(строка $name, целое число|null $mode = null, строка $description = '', строка|массив строк|null $default = null)

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

При некорректном режиме аргумента

$this addOption(string $name, string|array $shortcut = null, int|null $mode = null, string $description = '', string|string[]|bool|null $default = null)

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

Параметры

string	$name	Имя опции
string|array	$shortcut	Сокращения, может быть null, строкой сокращений, разделённых |, или массивом сокращений
int|null	$mode	Режим опции: одно из констант VALUE_*
string	$description	Текст описания
string|string[]|bool|null	$default	Значение по умолчанию (должно быть null для self::VALUE_NONE)

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

$this

Исключения

InvalidArgumentException

Если режим опции некорректен или несовместим

$this setName(string $name)

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

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

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

Параметры

string

$name

Имя команды

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

$this

Исключения

InvalidArgumentException

Если имя некорректно

$this setProcessTitle(string $title)

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

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

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

Параметры

string

$title

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

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

$this

string getName()

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

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

string

Имя команды

Command setHidden(bool $hidden)

Параметры

bool

$hidden

Скрыть команду из списка команд

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

Command

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

bool isHidden()

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

bool	Должна ли команда быть отображена публично

$this setDescription(string $description)

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

Параметры

string

$description

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

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

$this

string getDescription()

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

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

string

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

$this setHelp(string $help)

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

Параметры

string

$help

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

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

$this

string getHelp()

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

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

string

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

string getProcessedHelp()

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

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

string

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

$this setAliases(string[] $aliases)

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

Параметры

string[]

$aliases

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

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

$this

Исключения

InvalidArgumentException

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

array getAliases()

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

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

array

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

string getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

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

string

Краткое описание

$this addUsage(string $usage)

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

Параметры

string

$usage

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

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

$this

array getUsages()

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

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

array

mixed getHelper(string $name)

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

Параметры

string

$name

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

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

mixed

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

Исключения

LogicException	если не определён HelperSet
InvalidArgumentException	если помощник не определён