HelpCommand

__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

Вызываемый объект (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 не определен
Исключение неверного аргумента	если помощник не определен

setCommand(Команда $command)

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

Параметры

Команда

$command

Команда для установки