CachePoolClearCommand

static string|null getDefaultName()

Значение возвращаемого значения

string|null

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

__construct(Psr6CacheClearer $poolClearer)

Параметры

Psr6CacheClearer

$poolClearer

Исключения

LogicException

При пустом имени команды

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

protected configure()

Настраивает текущую команду.

protected int|null execute(InputInterface $input, OutputInterface $output)

Выполняет текущую команду.

Этот метод не абстрактный, потому что вы можете использовать этот класс как конкретный класс. В этом случае, вместо определения метода execute(), вы устанавливаете код для выполнения, передавая Closure в метод setCode().

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

int|null

null или 0, если всё прошло хорошо, или код ошибки

Исключения

LogicException

Если этот абстрактный метод не реализован

protected interact(InputInterface $input, OutputInterface $output)

Взаимодействует с пользователем.

Этот метод выполняется до проверки InputDefinition. Это означает, что это единственное место, где команда может интерактивно запросить значения отсутствующих обязательных аргументов.

Параметры

InputInterface	$input
OutputInterface	$output

protected initialize(InputInterface $input, OutputInterface $output)

Инициализирует команду после привязки входных данных и перед проверкой входных данных.

Это в основном полезно, когда много команд расширяют одну главную команду, где некоторые вещи должны быть инициализированы на основе аргументов и опций входных данных.

Параметры

InputInterface	$input
OutputInterface	$output

См. также

InputInterface::bind
InputInterface::validate

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

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

$this setDefinition(array|InputDefinition $definition)

Устанавливает массив экземпляров аргументов и опций.

Параметры

array|InputDefinition

$definition

Массив экземпляров аргументов и опций или экземпляр определения

Значение возвращаемого значения

$this

InputDefinition getDefinition()

Получает InputDefinition, прикреплённый к этой команде.

Значение возвращаемого значения

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

Получает InputDefinition, используемый для создания представлений этого Command.

Можно переопределить, чтобы предоставить исходное представление команды, когда оно в противном случае будет изменено путем объединения с приложением InputDefinition.

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

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

InputDefinition

Экземпляр InputDefinition

$this addArgument(string $name, int|null $mode = null, string $description = '', string|string[]|null $default = null)

Добавляет аргумент.

Параметры

string	$name	Имя аргумента
int|null	$mode	Режим аргумента: self::REQUIRED или self::OPTIONAL
string	$description	Текст описания
string|string[]|null	$default	Значение по умолчанию (только для режима self::OPTIONAL)

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

$this

Исключения

InvalidArgumentException

При некорректном режиме аргумента

$this addOption(string $name, string|array $shortcut = null, int|null $mode = null, string $description = '', string|string[]|bool|null $default = null)

Добавляет опцию.

Параметры

string	$name	Имя опции
string|array	$shortcut	Сокращения, может быть null, строка сокращений, разделенных |, или массив сокращений
int|null	$mode	Режим опции: Одно из констант VALUE_*
string	$description	Текст описания
string|string[]|bool|null	$default	Значение по умолчанию (должно быть null для self::VALUE_NONE)

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

$this

Исключения

InvalidArgumentException

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

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