ContainerDebugCommand

__construct(string|null $name = null)

Параметры

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

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

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

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

InputDefinition

Экземпляр InputDefinition

$this 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)

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

$this

$this 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)

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

$this

$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

Имя команды

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

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

^{устарело}

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

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

Результат

string

Строковое представление команды

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

^{устарело}

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

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

Параметры

bool

$asDom

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

Результат

string|DOMDocument

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

setContainer(ContainerInterface $container = null)

Параметры

ContainerInterface

$container