ServerStatusCommand

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

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

строка|null

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

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

Параметры

строка

$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

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

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

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

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