HelpCommand

static string|null getDefaultName()

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

string|null

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

__construct(string $name = null)

Параметры

string

$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

protected configure()

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

protected int|null execute(InputInterface $input, OutputInterface $output)

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int|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

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, которая должна использоваться для создания представлений этой команды.

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

Этот метод не является частью публичного API и не должен использоваться напрямую.

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

InputDefinition

Экземпляр InputDefinition

$this addArgument(string $name, int|null $mode = null, string $description = '', string|string[]|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	если помощник не определен

setCommand(Command $command)

Параметры

Command

$command