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

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

Command setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

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

Command

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

InputDefinition getDefinition()

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

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

Можно переопределить, чтобы предоставить исходное представление команды, когда оно в противном случае будет изменено путем объединения с 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

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

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

Команда

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

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

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

Исключения

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

setContainer(ContainerInterface $container = null)

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

Параметры

ContainerInterface

$container

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