ServerDumpPlaceholderCommand

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

Результат

строка|null

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

__construct(DumpServer $server = null, array $descriptors = array())

Параметры

DumpServer	$server
array	$descriptors

Исключения

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

protected configure()

Настраивает текущую команду.

protected целое число|null execute(InputInterface $input, OutputInterface $output)

Выполняет текущую команду.

Этот метод не является абстрактным, потому что вы можете использовать этот класс как конкретный класс. В этом случае, вместо определения метода execute(), вы устанавливаете код для выполнения, передав Closure в метод setCode().

Параметры

InputInterface	$input
OutputInterface	$output

Результат

целое число|null

null или 0, если всё прошло хорошо, или код ошибки

Исключения

LogicException

Когда этот абстрактный метод не реализован

protected interact(InputInterface $input, OutputInterface $output)

Взаимодействует с пользователем.

Этот метод выполняется до валидации InputDefinition. Это означает, что это единственное место, где команда может интерактивно запросить значения отсутствующих обязательных аргументов.

Параметры

InputInterface	$input
OutputInterface	$output

protected initialize(InputInterface $input, OutputInterface $output)

Инициализирует команду после того, как вход был привязан, и перед валидацией ввода.

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

Параметры

InputInterface	$input
OutputInterface	$output

См. также

InputInterface::bind
InputInterface::validate

целое число run(InputInterface $input, OutputInterface $output)

Выполняет команду.

Код для выполнения либо определяется непосредственно с помощью метода setCode(), либо путем переопределения метода execute() в подклассе.

Параметры

InputInterface	$input
OutputInterface	$output

Результат

целое число

Код завершения команды

Исключения

Исключение

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

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

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

Значение возврата

InputDefinition

Экземпляр InputDefinition

$this addArgument(string $name, int|null $mode = null, string $description = '', string|string[]|null $default = null)

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

Параметры

string	$name	Имя аргумента
int|null	$mode	Режим аргумента: self::REQUIRED или self::OPTIONAL
string	$description	Текст описания
string|string[]|null	$default	Значение по умолчанию (только для режима self::OPTIONAL)

Значение возврата

$this

Исключения

InvalidArgumentException

При некорректном режиме аргумента

$this addOption(string $name, string|array $shortcut = null, int|null $mode = null, string $description = '', string|string[]|bool|null $default = null)

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

Параметры

string	$name	Имя опции
string|array	$shortcut	Сокращения, могут быть null, строкой сокращений, разделенных |, или массивом сокращений
int|null	$mode	Режим опции: Один из констант VALUE_*
string	$description	Текст описания
string|string[]|bool|null	$default	Значение по умолчанию (должно быть null для self::VALUE_NONE)

Значение возврата

$this

Исключения

InvalidArgumentException

Если режим опции некорректен или несовместим

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