AssetsInstallCommand

static string|null getDefaultName()

Результат

string|null

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

__construct(Filesystem $filesystem = null)

Параметры

Filesystem

$filesystem

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

callable(InputInterface $input, OutputInterface $output)

Результат

$this

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

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

Параметры

bool

$mergeArgs

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

$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