InitAclCommand

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

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

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

Команда

Текущая инстанция

строка getName()

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

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

строка

Имя команды

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

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

Параметры

строка

$description

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

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

Команда

Текущая инстанция

строка getDescription()

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

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

строка

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

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

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

Параметры

строка

$help

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

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

Команда

Текущая инстанция

строка getHelp()

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

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

строка

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

строка getProcessedHelp()

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

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

строка

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

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

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

Параметры

строка[]

$aliases

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

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

Команда

Текущая инстанция

Исключения

InvalidArgumentException

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

массив getAliases()

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

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

массив

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

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

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

Параметры

bool

$short

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

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

строка

Синопсис

Команда addUsage(строка $usage)

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

Параметры

строка

$usage

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

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

Команда

Текущая инстанция

массив getUsages()

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

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

массив

смешанное getHelper(строка $name)

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

Параметры

строка

$name

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

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

смешанное

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

Исключения

LogicException	если HelperSet не определен
InvalidArgumentException	если помощник не определен

строка asText() ^{устарело}

^{устарело}

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

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

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

строка

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

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

^{устарело}

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

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

Параметры

bool

$asDom

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

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

строка|DOMDocument

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

setContainer(ContainerInterface $container = null)

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

Параметры

ContainerInterface

$container

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