DebugCommand

__construct(string|null $name = 'debug:twig')

Конструктор.

Параметры

string|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

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

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

setTwigEnvironment(Environment $twig)

Параметры

Environment

$twig