RouterDebugCommand

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

Результат

строка|null

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

__construct(Интерфейс маршрутизатора $router = null)

Параметры

Интерфейс маршрутизатора

$router

ignoreValidationErrors()

Игнорирует ошибки валидации.

Это полезно в основном для команды help.

setApplication(Приложение $application = null)

Параметры

Приложение

$application

setHelperSet(Набор помощников $helperSet)

Параметры

Набор помощников

$helperSet

Набор помощников getHelperSet()

Получает набор помощников.

Результат

Набор помощников

Экземпляр HelperSet

Приложение getApplication()

Получает экземпляр приложения для этой команды.

Результат

Приложение

Экземпляр Application

bool isEnabled()

Проверяет, включена ли команда в текущей среде.

Переопределите этот метод, чтобы проверить x или y и вернуть false, если команда не может корректно работать в текущих условиях.

Результат

bool

int run(Интерфейс ввода $input, Интерфейс вывода $output)

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

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

Параметры

Интерфейс ввода	$input
Интерфейс вывода	$output

Результат

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

Исключения

Исключение

При неудачном связывании входных данных. Это можно обойти, вызвав {@link ignoreValidationErrors()}.

См. также

setCode()
execute()

$this setCode(callable $code)

Устанавливает код для выполнения при запуске этой команды.

Если используется этот метод, он переопределяет код, определённый в методе execute().

Параметры

callable

$code

Вызов(InputInterface $input, OutputInterface $output)

Результат

$this

Исключения

Исключение некорректного аргумента

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

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

Параметры

bool

$mergeArgs

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

$this setDefinition(array|Определение ввода $definition)

Устанавливает массив экземпляров аргументов и опций.

Параметры

массив|Определение ввода

$definition

Массив экземпляров аргументов и опций или экземпляр определения

Результат

$this

Определение ввода getDefinition()

Получает определение ввода, прикреплённое к этой команде.

Результат

Определение ввода

Экземпляр InputDefinition

Определение ввода getNativeDefinition()

Получает определение ввода, используемое для создания представлений этой команды.

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

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

Результат

Определение ввода

Экземпляр 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

Исключения

Исключение некорректного аргумента

При некорректном имени

$this setProcessTitle(string $title)

Устанавливает заголовок процесса команды.

Эта функция должна использоваться только при создании команды с длительным процессом, например, демона.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

string

$title

Заголовок процесса

Результат

$this

строка getName()

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

Результат

строка

Имя команды

Команда 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