ServerCommand

__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

При неудачном привязке входных данных. Это можно обойти, вызвав {@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 $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

Имя команды

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	если помощник не определен