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.

Параметры

string

$title

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

Результат

Команда

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

string getName()

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

Результат

string

Имя команды

Команда setDescription(string $description)

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

Параметры

string

$description

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

Результат

Команда

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

string getDescription()

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

Результат

string

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

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

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

Параметры

string

$help

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

Результат

Команда

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

string getHelp()

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

Результат

string

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

string getProcessedHelp()

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

Результат

string

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

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

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

Параметры

string[]

$aliases

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

Результат

Команда

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

Исключения

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

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

array getAliases()

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

Результат

array

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

string getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

Результат

string

Синопсис

addUsage(string $usage)

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

Параметры

string

$usage

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

array getUsages()

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

Результат

array

mixed getHelper(string $name)

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

Параметры

string

$name

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

Результат

mixed

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

Исключения

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

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

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(ИнтерфейсКонтейнера $container = null)

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

Параметры

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

$container

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