HelpCommand

__construct(string|null $name = null)

Параметры

string|null

$name

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

Исключения

LogicException

Если имя команды пустое

ignoreValidationErrors()

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

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

setApplication(Application $application = null)

Параметры

Application

$application

setHelperSet(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
OutputInterface	$output

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

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

Исключения

Exception

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

См. также

setCode()
execute()

$this setCode(callable $code)

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

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

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

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

$this

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

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

Параметры

bool

$mergeArgs

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

$this setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

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

$this

InputDefinition getDefinition()

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

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

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

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

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

InputDefinition

Экземпляр InputDefinition

$this 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)

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

$this

$this 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)

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

$this

$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

Имя команды

$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% на реальные значения динамически.

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

строка

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

$this setAliases(string[] $aliases)

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

Параметры

массив строк

$aliases

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

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

$this

Исключения

InvalidArgumentException

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

массив getAliases()

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

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

массив

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

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

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

Параметры

булево

$short

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

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

строка

Синопсис

$this addUsage(string $usage)

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

Параметры

строка

$usage

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

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

$this

массив getUsages()

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

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

массив

смешанный тип getHelper(string $name)

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

Параметры

строка

$name

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

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

смешанный тип

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

Исключения

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

строка asText() ^{устаревшее}

^{устаревшее}

с версии 2.3, будет удалено в 3.0.

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

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

строка

Строковое представление команды

строка|DOMDocument asXml(bool $asDom = false) ^{устаревшее}

^{устаревшее}

с версии 2.3, будет удалено в 3.0.

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

Параметры

булево

$asDom

Возвращать DOM или строку XML

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

строка|DOMDocument

XML-представление команды

setCommand(Command $command)

Параметры

Command

$command