CacheWarmupCommand

__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

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

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

Command

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

string getName()

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

Результат

string

Имя команды

Command setDescription(string $description)

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

Параметры

string

$description

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

Результат

Command

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

string getDescription()

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

Результат

string

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

Command setHelp(string $help)

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

Параметры

string

$help

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

Результат

Command

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

string getHelp()

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

Результат

string

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

string getProcessedHelp()

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

Результат

string

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

Command setAliases(string[] $aliases)

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

Параметры

string[]

$aliases

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

Результат

Command

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

Исключения

InvalidArgumentException

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

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

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

Исключения

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

setContainer(ContainerInterface $container = null)

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

Параметры

ContainerInterface

$container

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