InitAclCommand ^deprecated

static string|null getDefaultName()

Значение возвращаемого значения

string|null

Имя команды по умолчанию или null, если имя по умолчанию не установлено

__construct($connection = null, Schema $schema = null)

Параметры

	$connection
Schema	$schema

Исключения

LogicException

При пустом имени команды

ignoreValidationErrors()

Игнорирует ошибки валидации.

Это полезно в основном для команды help.

setApplication(Application $application = null)

Параметры

Application

$application

setHelperSet(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
OutputInterface	$output

Значение возвращаемого значения

int	Код завершения команды

Исключения

Exception

При сбое привязки входных данных. Проигнорировать это, вызвав {@link ignoreValidationErrors()}.

См. также

setCode()
execute()

$this setCode(callable $code)

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

Если этот метод используется, он переопределяет код, определенный в методе execute().

Параметры

callable

$code

Вызываемый объект (InputInterface $input, OutputInterface $output)

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

Объединяет определение приложения с определением команды.

Этот метод не является частью публичного API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

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

$this setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

Значение возвращаемого значения

$this

InputDefinition getDefinition()

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

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

Можно переопределить, чтобы предоставить исходное представление команды, когда в противном случае оно будет изменено путем объединения с InputDefinition приложения.

Этот метод не является частью публичного API и не должен использоваться напрямую.

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

$this 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)

Значение возвращаемого значения

$this

$this 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)

Значение возвращаемого значения

$this

$this setName(string $name)

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

Этот метод может установить и имя пространства имен, и имя, если вы разделите их двоеточием (:).

$command->setName('foo:bar');

Параметры

string

$name

Имя команды

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

При недопустимом имени

$this setProcessTitle(string $title)

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

Эта функция должна использоваться только при создании команды с длительным процессом, например, демона.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

string

$title

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

Значение возвращаемого значения

$this

string getName()

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

Значение возвращаемого значения

string

Имя команды

Command setHidden(bool $hidden)

Параметры

bool

$hidden

Скрывать ли команду из списка команд

Значение возвращаемого значения

Command

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

bool isHidden()

Значение возвращаемого значения

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

$this setDescription(string $description)

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

Параметры

string

$description

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

Значение возвращаемого значения

$this

string getDescription()

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

Значение возвращаемого значения

string

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

$this setHelp(string $help)

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

Параметры

string

$help

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

Значение возвращаемого значения

$this

string getHelp()

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

Значение возвращаемого значения

string

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

string getProcessedHelp()

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

Значение возвращаемого значения

string

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

$this setAliases(string[] $aliases)

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

Параметры

string[]

$aliases

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

Значение возвращаемого значения

$this

Исключения

InvalidArgumentException

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

array getAliases()

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

Значение возвращаемого значения

array

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

string getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

Значение возвращаемого значения

string

Сводка

$this addUsage(string $usage)

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

Параметры

string

$usage

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

Значение возвращаемого значения

$this

array getUsages()

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

Значение возвращаемого значения

array

mixed getHelper(string $name)

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

Параметры

string

$name

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

Значение возвращаемого значения

mixed

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

Исключения

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

setContainer(ContainerInterface $container = null)

Параметры

ContainerInterface

$container