ServerRunCommand

__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

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

Можно переопределить, чтобы предоставить исходное представление команды, когда иначе оно изменяется путем слияния с 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

Заголовок процесса

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

Команда

Текущий экземпляр

строка getName()

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

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

строка

Имя команды

Команда setDescription(строка $description)

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

Параметры

строка

$description

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

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

Команда

Текущий экземпляр

строка getDescription()

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

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

строка

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

Команда setHelp(строка $help)

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

Параметры

строка

$help

Справка для команды

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

Команда

Текущий экземпляр

строка getHelp()

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

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

строка

Справка для команды

строка getProcessedHelp()

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

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

строка

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

Команда setAliases(строка[] $aliases)

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

Параметры

строка[]

$aliases

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

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

Команда

Текущий экземпляр

Исключения

InvalidArgumentException

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

массив getAliases()

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

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

массив

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

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

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

Параметры

bool

$short

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

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

строка

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

Команда addUsage(строка $usage)

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

Параметры

строка

$usage

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

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

Команда

Текущий экземпляр

массив getUsages()

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

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

массив

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

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

Параметры

строка

$name

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

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

смешанный

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

Исключения

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

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

^{устарело}

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

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

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

строка

Строка, представляющая команду

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

^{устарело}

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

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

Параметры

bool

$asDom

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

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

строка|DOMDocument

XML-строка, представляющая команду

setContainer(ContainerInterface $container = null)

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

Параметры

ContainerInterface

$container

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