AssetsInstallCommand

__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

При неудачном связывании входных данных. Можно обойти это, вызвав {@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, используемую для создания XML и текстовых представлений этой команды.

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

Имя команды

$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	если помощник не определен

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

^{устарело}

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

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

Значение результата

string

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

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

^{устарело}

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

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

Параметры

bool

$asDom

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

Значение результата

string|DOMDocument

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

setContainer(ContainerInterface $container = null)

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

Параметры

ContainerInterface

$container

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