RouterApacheDumperCommand ^deprecated

__construct(string|null $name = null)

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

Параметры

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

См. также

setCode()
execute()

Command setCode(callable $code)

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

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

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

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

Command

Текущий экземпляр

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

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

Параметры

bool

$mergeArgs

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

Command setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

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

Command

Текущий экземпляр

InputDefinition getDefinition()

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

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

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

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

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

InputDefinition

Экземпляр InputDefinition

Command 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)

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

Command

Текущий экземпляр

Command 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_REQUIRED или InputOption::VALUE_NONE)

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

Command

Текущий экземпляр

Command setName(string $name)

Устанавливает имя команды.

Этот метод может установить как имя пространства имён, так и имя, если вы разделите их двоеточием (:)

$command->setName('foo:bar');

Параметры

string

$name

Имя команды

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

Command

Текущий экземпляр

Исключения

InvalidArgumentException

При недопустимом имени

Command setProcessTitle(string $title)

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

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

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

Параметры

строка

$title

Название процесса

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

Команда

Текущий экземпляр

строка getName()

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

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

строка

Имя команды

Команда setDescription(строка $description)

Устанавливает описание для команды.

Параметры

строка

$description

Описание команды

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

Команда

Текущий экземпляр

строка getDescription()

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

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

строка

Описание команды

Команда setHelp(строка $help)

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

Параметры

строка

$help

Справка для команды

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

Команда

Текущий экземпляр

строка getHelp()

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

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

строка

Справка для команды

строка getProcessedHelp()

Возвращает обработанную справку для команды, заменяя шаблоны %command.name% и %command.full_name% на реальные значения динамически.

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

строка

Обработанная справка для команды

Команда setAliases(строка[] $aliases)

Устанавливает псевдонимы для команды.

Параметры

строка[]

$aliases

Массив псевдонимов для команды

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

Команда

Текущий экземпляр

Исключения

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

При некорректном псевдониме

массив getAliases()

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

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

массив

Массив псевдонимов для команды

строка getSynopsis(bool $short = false)

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

Параметры

bool

$short

Показывать короткую версию синопсиса (с опциями свёрнутыми) или нет

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

строка

Синопсис

addUsage(строка $usage)

Добавляет пример использования команды.

Параметры

строка

$usage

Использование, оно будет добавлено с именем команды

массив getUsages()

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

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

массив

смешанный тип getHelper(строка $name)

Получает экземпляр помощника по имени.

Параметры

строка

$name

Имя помощника

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

смешанный тип

Значение помощника

Исключения

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

если помощник не определён

строка asText() ^{устаревший}

^{устаревший}

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

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

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

строка

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

строка|DOMDocument asXml(bool $asDom = false) ^{устаревший}

^{устаревший}

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

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

Параметры

bool

$asDom

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

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

строка|DOMDocument

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

setContainer(Интерфейс контейнера $container = null)

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

Параметры

Интерфейс контейнера

$container

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