ClearCommand

class ClearCommand extends Command (View source)

Свойства

CallsCommands

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	Фабрика компонентов консоли.	from InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	from InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	from InteractsWithIO
protected int	$verbosity	Уровень детализации вывода по умолчанию для команд.	from InteractsWithIO
protected array	$verbosityMap	Сопоставление уровней детализации (человекочитаемый вид) и Symfony's OutputInterface.	from InteractsWithIO
protected Signals\|null	$signals	Экземпляр регистратора сигналов.	from InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	from Macroable
protected Application	$laravel	Экземпляр приложения Laravel.	from Command
protected string	$signature	Имя и сигнатура команды консоли.	from Command
protected string	$name	Имя команды консоли.
protected string	$description	Описание команды консоли.
protected string	$help	Текст справки для команды консоли.	from Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	from Command
static protected string\|null deprecated	$defaultName	Имя команды консоли.
protected CacheManager	$cache	Экземпляр менеджера кэша.
protected Filesystem	$files	Экземпляр файловой системы.

Методы

Команда	resolveCommand(Команда\|строка $command) Разрешить экземпляр консольной команды для заданной команды.	из CallsCommands
int	call(Команда\|строка $command, массив $arguments = []) Вызвать другую консольную команду.	из CallsCommands
int	callSilent(Команда\|строка $command, массив $arguments = []) Вызвать другую консольную команду без вывода.	из CallsCommands
int	callSilently(Команда\|строка $command, массив $arguments = []) Вызвать другую консольную команду без вывода.	из CallsCommands
int	runCommand(Команда\|строка $command, массив $arguments, OutputInterface $output) Выполнить заданную консольную команду.	из CallsCommands
ArrayInput	createInputFromArguments(массив $arguments) Создать экземпляр ввода из заданных аргументов.	из CallsCommands
массив	context() Получить весь контекст, переданный команде.	из CallsCommands
void	specifyParameters() Указать аргументы и параметры команды.	из HasParameters
массив	getArguments() Получить аргументы консольной команды.
массив	getOptions() Получить параметры консольной команды.
bool	hasArgument(строка\|int $name) Определить, присутствует ли заданный аргумент.	из InteractsWithIO
массив\|строка\|bool\|null	argument(строка\|null $key = null) Получить значение аргумента команды.	из InteractsWithIO
массив	arguments() Получить все аргументы, переданные команде.	из InteractsWithIO
bool	hasOption(строка $name) Определить, присутствует ли заданный параметр.	из InteractsWithIO
строка\|массив\|bool\|null	option(строка\|null $key = null) Получить значение параметра команды.	из InteractsWithIO
массив	options() Получить все параметры, переданные команде.	из InteractsWithIO
bool	confirm(строка $question, bool $default = false) Подтвердить вопрос у пользователя.	из InteractsWithIO
mixed	ask(строка $question, строка\|null $default = null) Запросить ввод у пользователя.	из InteractsWithIO
mixed	anticipate(строка $question, массив\|замыкание $choices, строка\|null $default = null) Запросить ввод у пользователя с автодополнением.	из InteractsWithIO
mixed	askWithCompletion(строка $question, массив\|замыкание $choices, строка\|null $default = null) Запросить ввод у пользователя с автодополнением.	из InteractsWithIO
mixed	secret(строка $question, bool $fallback = true) Запросить ввод у пользователя, но скрыть ответ в консоли.	из InteractsWithIO
строка\|массив	choice(строка $question, массив $choices, строка\|int\|null $default = null, mixed\|null $attempts = null, bool $multiple = false) Предложить пользователю один выбор из массива ответов.	из InteractsWithIO
void	table(массив $headers, Arrayable\|массив $rows, TableStyle\|строка $tableStyle = 'default', массив $columnStyles = []) Форматировать входные данные в текстовую таблицу.	из InteractsWithIO
mixed\|void	withProgressBar(iterable\|int $totalSteps, Closure $callback) Выполнить заданный обратный вызов, продвигая полосу прогресса.	из InteractsWithIO
void	info(строка $string, int\|строка\|null $verbosity = null) Записать строку в качестве вывода информации.	из InteractsWithIO
void	line(строка $string, строка\|null $style = null, int\|строка\|null $verbosity = null) Записать строку в качестве стандартного вывода.	из InteractsWithIO
void	comment(строка $string, int\|строка\|null $verbosity = null) Записать строку в качестве комментария.	из InteractsWithIO
void	question(строка $string, int\|строка\|null $verbosity = null) Записать строку в качестве вопроса.	из InteractsWithIO
void	error(строка $string, int\|строка\|null $verbosity = null) Записать строку в качестве ошибки.	из InteractsWithIO

void	warn(string $string, int\|string\|null $verbosity = null) Вывести строку как предупреждение.	из InteractsWithIO
void	alert(string $string, int\|string\|null $verbosity = null) Вывести строку в окне предупреждения.	из InteractsWithIO
$this	newLine(int $count = 1) Вывести пустую строку.	из InteractsWithIO
void	setInput(InputInterface $input) Установить реализацию интерфейса ввода.	из InteractsWithIO
void	setOutput(OutputStyle $output) Установить реализацию интерфейса вывода.	из InteractsWithIO
void	setVerbosity(string\|int $level) Установить уровень подробности.	из InteractsWithIO
int	parseVerbosity(string\|int\|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony.	из InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	из InteractsWithIO
void	trap(iterable<array-key,int>\|int $signals, $callback) Определить обработчик, который будет выполняться при возникновении заданного сигнала(ов).	из InteractsWithSignals
void	untrap() Убрать обработчики сигналов, установленные в обработчике команды.	из InteractsWithSignals
void	interact(InputInterface $input, OutputInterface $output) Взаимодействовать с пользователем перед валидацией ввода.	из PromptsForMissingInput
void	promptForMissingArguments(InputInterface $input, OutputInterface $output) Запросить у пользователя отсутствующие аргументы.	из PromptsForMissingInput
array	promptForMissingArgumentsUsing() Запрос отсутствующих входных аргументов с использованием возвращенных вопросов.	из PromptsForMissingInput
void	afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output) Выполнить действия после того, как пользователя попросили предоставить отсутствующие аргументы.	из PromptsForMissingInput
bool	didReceiveOptions(InputInterface $input) Содержит ли входные данные какие-либо опции, отличные от значений по умолчанию.	из PromptsForMissingInput
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверка, зарегистрировано ли макро.	из Macroable
static void	flushMacros() Очистить существующие макросы.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамическое обращение к классу.	из Macroable
mixed	__call(string $method, array $parameters) Динамическое обращение к классу.	из Macroable
void	__construct(CacheManager $cache, Filesystem $files) Создать новый экземпляр команды очистки кэша.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	из Command
void	configureIsolation() Настроить команду консоли для изоляции.	из Command
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	из Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	из Command
bool	isHidden() {@inheritdoc}	из Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	из Command

Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
void	handle() Выполнить консольную команду.
void	flushFacades() Очистить фейды реального времени, сохраненные в каталоге кеша.
Репозиторий	cache() Получить экземпляр кеша для команды.
массив	tags() Получить теги, переданные в команду.

Подробности

abstract protected Команда resolveCommand(Команда|строка $command)

Разрешить экземпляр консольной команды для заданной команды.

Параметры

Команда|строка

$command

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

Команда

int call(Команда|строка $command, массив $arguments = [])

Вызвать другую консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

int callSilent(Команда|строка $command, массив $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

int callSilently(Команда|строка $command, массив $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

protected int runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

Запустить заданную консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments
OutputInterface	$output

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

int

protected ArrayInput createInputFromArguments(массив $arguments)

Создать экземпляр ввода из заданных аргументов.

Параметры

массив

$arguments

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

ArrayInput

protected массив context()

Получить весь контекст, переданный команде.

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

массив

protected void specifyParameters()

Указать аргументы и опции команды.

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

void

protected массив getArguments()

Получить аргументы консольной команды.

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

массив

protected массив getOptions()

Получить опции консольной команды.

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

массив

bool hasArgument(строка|int $name)

Определить, присутствует ли данный аргумент.

Параметры

строка|int

$name

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

bool

массив|строка|bool|null argument(строка|null $key = null)

Получить значение аргумента команды.

Параметры

строка|null

$key

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

массив|строка|bool|null

массив arguments()

Получить все аргументы, переданные команде.

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

массив

bool hasOption(строка $name)

Определить, присутствует ли данная опция.

Параметры

строка

$name

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

bool

строка|массив|bool|null option(строка|null $key = null)

Получить значение опции команды.

Параметры

строка|null

$key

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

строка|массив|bool|null

массив options()

Получить все опции, переданные команде.

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

массив

bool confirm(строка $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

строка	$question
bool	$default

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

bool

смешанный ask(строка $question, строка|null $default = null)

Задать вопрос пользователю для ввода.

Параметры

строка	$question
строка\|null	$default

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

смешанный

смешанный anticipate(строка $question, массив|вызов $choices, строка|null $default = null)

Задать вопрос пользователю с автозаполнением.

Параметры

строка	$question
массив\|вызов	$choices
строка\|null	$default

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

смешанный

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Запросить у пользователя ввод с автозаполнением.

Параметры

string	$question
array\|callable	$choices
string\|null	$default

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

mixed

mixed secret(string $question, bool $fallback = true)

Запросить у пользователя ввод, но скрыть ответ из консоли.

Параметры

string	$question
bool	$fallback

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

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Предложить пользователю один выбор из массива ответов.

Параметры

string	$question
array	$choices
string\|int\|null	$default
mixed\|null	$attempts
bool	$multiple

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

string|array

void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Форматирование ввода в текстовую таблицу.

Параметры

array	$headers
Arrayable\|array	$rows
TableStyle\|string	$tableStyle
array	$columnStyles

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

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, одновременно продвигая полосу прогресса.

Параметры

iterable\|int	$totalSteps
Closure	$callback

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

mixed|void

void info(string $string, int|string|null $verbosity = null)

Записать строку в качестве информационного вывода.

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Записать строку в стандартный вывод.

Параметры

string	$string
string\|null	$style
int\|string\|null	$verbosity

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

void

void comment(string $string, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void question(string $string, int|string|null $verbosity = null)

Записать строку как вывод вопроса.

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void error(string $string, int|string|null $verbosity = null)

Записать строку как вывод ошибки.

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void warn(string $string, int|string|null $verbosity = null)

Записать строку как предупреждение.

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void alert(string $string, int|string|null $verbosity = null)

Записать строку в поле с предупреждением.

Параметры

string	$string
int\|string\|null	$verbosity

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

void

$this newLine(int $count = 1)

Написать пустую строку.

Параметры

int

$count

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

$this

void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface

$input

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

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle

$output

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

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Параметры

string|int

$level

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

void

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности с точки зрения уровня OutputInterface Symfony.

Параметры

string|int|null

$level

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

int

OutputStyle getOutput()

Получить реализацию вывода.

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

OutputStyle

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов, который будет выполнен при возникновении данного сигнала(ов).

Параметры

iterable<array-key,int>\|int	$signals
	$callback

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

void

void untrap()

internal

Отменить обработку сигналов, установленных в обработчике команды.

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

void

protected void interact(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запрос у пользователя отсутствующих аргументов.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected array promptForMissingArgumentsUsing()

Запрос отсутствующих аргументов ввода, используя возвращенные вопросы.

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнение действий после запроса у пользователя отсутствующих аргументов.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected bool didReceiveOptions(InputInterface $input)

Указывает, содержит ли ввод какие-либо опции, отличающиеся от значений по умолчанию.

Параметры

InputInterface

$input

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

bool

static void macro(string $name, object|callable $macro)

Регистрация пользовательского макроса.

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешивание другого объекта в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверка наличия зарегистрированного макроса.

Параметры

string

$name

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

bool

static void flushMacros()

Очистка существующих макросов.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

void __construct(CacheManager $cache, Filesystem $files)

Создание нового экземпляра команды очистки кэша.

Параметры

CacheManager	$cache
Filesystem	$files

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

void

protected void configureUsingFluentDefinition()

Настройка команды консоли с помощью определения fluent.

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

void

protected void configureIsolation()

Настройка команды консоли для изоляции.

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

void

int run(InputInterface $input, OutputInterface $output)

Запуск команды консоли.

Параметры

InputInterface	$input
OutputInterface	$output

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

int

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

Выполнение команды консоли.

Параметры

InputInterface	$input
OutputInterface	$output

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

int

protected CommandMutex commandIsolationMutex()

Получение экземпляра мьютекса изоляции команды для команды.

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

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

Command

END_OF_DOCUMENT_MARKER

Приложение getLaravel()

Получить экземпляр приложения Laravel.

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

Приложение

void setLaravel(Контейнер $laravel)

Установить экземпляр приложения Laravel.

Параметры

Контейнер

$laravel

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

void

void handle()

Выполнить консольную команду.

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

void

void flushFacades()

Очистить кэшированные фасадные объекты реального времени в каталоге кэша.

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

void

protected Репозиторий cache()

Получить экземпляр кэша для команды.

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

Репозиторий

protected array tags()

Получить теги, переданные команде.

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

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Cache/Console/ClearCommand.html