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	Код завершения команды

См. также

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)

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

Параметры

строка

$description

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

Возвращаемое значение

$this

строка getDescription()

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

Возвращаемое значение

строка

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

$this setHelp(строка $help)

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

Параметры

строка

$help

Помощь по команде

Возвращаемое значение

$this

строка getHelp()

Возвращает помощь по команде.

Возвращаемое значение

строка

Помощь по команде

строка getProcessedHelp()

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

Возвращаемое значение

строка

Обработанная помощь по команде

$this setAliases(строка[] $aliases)

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

Параметры

строка[]

$aliases

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

Возвращаемое значение

$this

Исключения

InvalidArgumentException

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

массив getAliases()

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

Возвращаемое значение

массив

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

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

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

Параметры

bool

$short

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

Возвращаемое значение

строка

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

$this addUsage(строка $usage)

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

Параметры

строка

$usage

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

Возвращаемое значение

$this

массив getUsages()

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

Возвращаемое значение

массив

смешанное getHelper(строка $name)

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

Параметры

строка

$name

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

Возвращаемое значение

смешанное

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

Исключения

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

setContainer(ContainerInterface $container = null)

Устанавливает контейнер.

Параметры

ContainerInterface

$container

Экземпляр ContainerInterface или null