Spec-Zone.ru › Laravel 10

ScheduleClearCacheCommand

class ScheduleClearCacheCommand extends Command (View source)

Трейты

CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

The console components factory.

from InteractsWithIO
protected InputInterface $input

The input interface implementation.

from InteractsWithIO
protected OutputStyle $output

The output interface implementation.

from InteractsWithIO
protected int $verbosity

The default verbosity of output commands.

from InteractsWithIO
protected array $verbosityMap

The mapping between human readable verbosity levels and Symfony's OutputInterface.

from InteractsWithIO
protected Signals|null $signals

The signal registrar instance.

from InteractsWithSignals
static protected array $macros

The registered string macros.

from Macroable
protected Application $laravel

The Laravel application instance.

from Command
protected string $signature

The name and signature of the console command.

from Command
protected string $name

The console command name.

protected string $description

The console command description.

protected string $help

The console command help text.

from Command
protected bool $hidden

Indicates whether the command should be shown in the Artisan command list.

from Command
protected bool $isolated

Indicates whether only one instance of the command can run at any given time.

from Command
protected int $isolatedExitCode

The default exit code for isolated commands.

from Command
protected array $aliases

The console command name aliases.

from Command

Методы

Команда resolveCommand(Command|string $command)

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

из CallsCommands
int call(Command|string $command, array $arguments = [])

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

из CallsCommands
int callSilent(Command|string $command, array $arguments = [])

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

из CallsCommands
int callSilently(Command|string $command, array $arguments = [])

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

из CallsCommands
int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

из CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

из CallsCommands
массив context()

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

из CallsCommands
void configurePrompts(InputInterface $input)

Настроить резервные варианты запросов.

из ConfiguresPrompts
mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Запрашивать у пользователя данные до тех пор, пока заданная функция проверки не вернёт true.

из ConfiguresPrompts
void restorePrompts()

Восстановить вывод запросов.

из ConfiguresPrompts
void specifyParameters()

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

из HasParameters
массив getArguments()

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

из HasParameters
массив getOptions()

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

из HasParameters
bool hasArgument(string|int $name)

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

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

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

из InteractsWithIO
массив arguments()

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

из InteractsWithIO
bool hasOption(string $name)

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

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

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

из InteractsWithIO
массив options()

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

из InteractsWithIO
bool confirm(string $question, bool $default = false)

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

из InteractsWithIO
mixed ask(string $question, string|null $default = null)

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

из InteractsWithIO
mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

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

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

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

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

из InteractsWithIO
строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

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

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

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

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

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

Вывести строку как информацию.

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

Вывести строку в стандартный вывод.

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

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

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

Вывести строку в виде вопроса.

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

Вывести строку в виде ошибки.

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

Вывести строку в виде предупреждения.

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

Вывести строку в виде предупреждения (в всплывающем окне).

from InteractsWithIO
$this newLine(int $count = 1)

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

from InteractsWithIO
void setInput(InputInterface $input)

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

from InteractsWithIO
void setOutput(OutputStyle $output)

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

from InteractsWithIO
void setVerbosity(string|int $level)

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

from InteractsWithIO
int parseVerbosity(string|int|null $level = null)

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

from InteractsWithIO
OutputStyle getOutput()

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

from InteractsWithIO
Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

from InteractsWithIO
trap($signals, $callback)

Нет описания

from InteractsWithSignals
void untrap()

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

from InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

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

from PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

from PromptsForMissingInput
array promptForMissingArgumentsUsing()

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

from PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

from PromptsForMissingInput
bool didReceiveOptions(InputInterface $input)

Содержит ли входные данные какие-либо параметры, отличные от значений по умолчанию.

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

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

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

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

from Macroable
static bool hasMacro(string $name)

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

from Macroable
static void flushMacros()

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

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

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

from Macroable
mixed __call(string $method, array $parameters)

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

from Macroable
void __construct()

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

from Command
void configureUsingFluentDefinition()

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

from Command
void configureIsolation()

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

from Command
int run(InputInterface $input, OutputInterface $output)

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

from Command
int execute(InputInterface $input, OutputInterface $output)

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

from Command
CommandMutex commandIsolationMutex()

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

из Команды
bool isHidden()

{@inheritdoc}

из Команды
Команда setHidden(bool $hidden = true)

{@inheritdoc}

из Команды
Приложение getLaravel()

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

из Команды
void setLaravel(Контейнер $laravel)

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

из Команды
void handle(График $schedule)

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

Подробности

abstract protected Команда resolveCommand(Команда|string $command)

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

Параметры

Команда|string $command

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

Команда

int call(Команда|string $command, array $arguments = [])

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

Параметры

Команда|string $command
array $arguments

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

int

int callSilent(Команда|string $command, array $arguments = [])

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

Параметры

Команда|string $command
array $arguments

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

int

int callSilently(Команда|string $command, array $arguments = [])

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

Параметры

Команда|string $command
array $arguments

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

int

protected int runCommand(Команда|string $command, array $arguments, OutputInterface $output)

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

Параметры

Команда|string $command
array $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

protected void configurePrompts(InputInterface $input)

Настроить отступы для подсказок.

Параметры

InputInterface $input

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

void
END_OF_DOCUMENT_MARKER

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure $prompt
bool|string $required
Closure|null $validate

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

mixed

protected void restorePrompts()

Восстановить вывод запросов.

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

array|string|bool|null argument(string|null $key = null)

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

Параметры

string|null $key

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

array|string|bool|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string $name

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

bool

string|array|bool|null option(string|null $key = null)

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

Параметры

string|null $key

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

string|array|bool|null

массив options()

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

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

массив

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

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

Параметры

строка $question
bool $default

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

bool

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

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

Параметры

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

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

смешанный тип

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

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

Параметры

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

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

смешанный тип

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

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

Параметры

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

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

смешанный тип

смешанный тип secret(строка $question, bool $fallback = true)

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

Параметры

строка $question
bool $fallback

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

смешанный тип

строка|массив choice(строка $question, массив $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Параметры

строка $question
массив $choices
string|int|null $default
mixed|null $attempts
bool $multiple

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

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

void table(массив $headers, Arrayable|массив $rows, TableStyle|строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

массив $headers
Arrayable|массив $rows
TableStyle|строка $tableStyle
массив $columnStyles

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

void

смешанный тип|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable|int $totalSteps
Closure $callback

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

смешанный тип|void

void info(строка $string, int|string|null $verbosity = null)

Вывести строку с информацией.

Параметры

строка $string
int|string|null $verbosity

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

void

void line(строка $string, string|null $style = null, int|string|null $verbosity = null)

Вывести строку в стандартный вывод.

Параметры

строка $string
string|null $style
int|string|null $verbosity

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

void

void comment(строка $string, int|string|null $verbosity = null)

Вывести строку как комментарий.

Параметры

строка $string
int|string|null $verbosity

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

void

void question(строка $string, int|string|null $verbosity = null)

Вывести строку как вопрос.

Параметры

строка $string
int|string|null $verbosity

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

void

void error(строка $string, int|string|null $verbosity = null)

Вывести строку как ошибку.

Параметры

строка $string
int|string|null $verbosity

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

void

void warn(строка $string, int|string|null $verbosity = null)

Вывести строку как предупреждение.

Параметры

строка $string
int|string|null $verbosity

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

void

void alert(строка $string, int|string|null $verbosity = null)

Вывести строку в диалоговом окне.

Параметры

строка $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

Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

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

Factory

trap($signals, $callback)

Без описания

Параметры

$signals
$callback

void untrap()

внутренний

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

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

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()

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

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

void

protected void configureUsingFluentDefinition()

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

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

void

protected void configureIsolation()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int
END_OF_DOCUMENT_MARKER

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

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

void handle(Schedule $schedule)

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

Параметры

Schedule $schedule

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

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API