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(string $description)

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

Параметры

строка

$description

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

Возвращаемое значение

Команда

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

строка getDescription()

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

Возвращаемое значение

строка

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

Команда setHelp(string $help)

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

Параметры

строка

$help

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

Возвращаемое значение

Команда

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

строка getHelp()

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

Возвращаемое значение

строка

Справка по команде

строка getProcessedHelp()

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

Возвращаемое значение

строка

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

Команда setAliases(string[] $aliases)

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

Параметры

строка[]

$aliases

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

Возвращаемое значение

Команда

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

Исключения

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

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

массив getAliases()

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

Возвращаемое значение

массив

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

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

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

Параметры

bool

$short

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

Возвращаемое значение

строка

Сводка

addUsage(string $usage)

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

Параметры

строка

$usage

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

массив getUsages()

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

Возвращаемое значение

массив

смешанный тип getHelper(string $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