ServerStatusCommand

static строка|null getDefaultName()

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

строка|null

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

__construct(строка|null $name = null)

Параметры

строка|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

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

$this setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

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

$this

InputDefinition getDefinition()

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

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

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

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

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

InputDefinition

Экземпляр InputDefinition

$this addArgument(строка $name, int $mode = null, строка $description = '', смешанный $default = null)

Добавляет аргумент.

Параметры

строка	$name	Имя аргумента
int	$mode	Режим аргумента: InputArgument::REQUIRED или InputArgument::OPTIONAL
строка	$description	Текст описания
смешанный	$default	Значение по умолчанию (только для режима InputArgument::OPTIONAL)

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

$this

$this addOption(строка $name, строка $shortcut = null, int $mode = null, строка $description = '', смешанный $default = null)

Добавляет опцию.

Параметры

строка	$name	Имя опции
строка	$shortcut	Сокращение (может быть null)
int	$mode	Режим опции: Один из констант InputOption::VALUE_*
строка	$description	Текст описания
смешанный	$default	Значение по умолчанию (должно быть null для InputOption::VALUE_NONE)

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

$this

$this setName(строка $name)

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

Этот метод может устанавливать как имя пространства имен, так и имя, если вы разделите их двоеточием (:)

$command->setName('foo:bar');

Параметры

строка

$name

Имя команды

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

$this

Исключения

InvalidArgumentException

При неверном имени

$this setProcessTitle(строка $title)

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

Эта функция должна использоваться только при создании команды длительного процесса, такой как демон.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

строка

$title

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

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

$this

строка getName()

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

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

строка

Имя команды

Command setHidden(bool $hidden)

Параметры

bool

$hidden

Скрыть или нет команду из списка команд

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

Команда

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

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