CacheClearCommand

__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

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

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(ИнтерфейсКонтейнера $container = null)

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

Параметры

ИнтерфейсКонтейнера

$container

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