ExportCommand ^deprecated

__construct(Profiler $profiler = null)

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

Параметры

Profiler

$profiler

Исключения

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

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

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

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

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

смешанный

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

Исключения

Логическая ошибка	если HelperSet не определен
Исключение неверного аргумента	если помощник не определен

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

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

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

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

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

строка

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

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

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

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

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

Параметры

bool

$asDom

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

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

строка|DOMDocument

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