CacheClearCommand

static string|null getDefaultName()

Возвращаемое значение

string|null

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

__construct(CacheClearerInterface $cacheClearer = null, Filesystem $filesystem = null)

Параметры

CacheClearerInterface	$cacheClearer
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

Функция(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

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

Возвращаемое значение

Команда

Текущая инстанция

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