ConfigDumpReferenceCommand

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, прикрепленный к этой команде.

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

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

setContainer(ContainerInterface $container = null)

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

Параметры

ContainerInterface

$container

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

filterToServiceTypes($serviceId)

Параметры

$serviceId

validateConfiguration(ExtensionInterface $extension, $configuration)

Параметры

ExtensionInterface	$extension
	$configuration