ScheduleClearCacheCommand
class ScheduleClearCacheCommand extends Command (View source)
Traits
CallsCommands | |
HasParameters | |
InteractsWithIO | |
InteractsWithSignals | |
PromptsForMissingInput | |
Macroable |
Properties
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 |
$hidden | Indicates whether the command should be shown in the Artisan command list. | from Command |
Methods
Command | resolveCommand(Command|string $command)
Resolve the console command instance for the given command. | from CallsCommands |
int | call(Command|string $command, array $arguments = [])
Call another console command. | from CallsCommands |
int | callSilent(Command|string $command, array $arguments = [])
Call another console command without output. | from CallsCommands |
int | callSilently(Command|string $command, array $arguments = [])
Call another console command without output. | from CallsCommands |
int | runCommand(Command|string $command, array $arguments, OutputInterface $output)
Run the given the console command. | from CallsCommands |
ArrayInput | createInputFromArguments(array $arguments)
Create an input instance from the given arguments. | from CallsCommands |
array | context()
Get all of the context passed to the command. | from CallsCommands |
void | specifyParameters()
Specify the arguments and options on the command. | from HasParameters |
array | getArguments()
Get the console command arguments. | from HasParameters |
array | getOptions()
Get the console command options. | from HasParameters |
bool | hasArgument(string|int $name)
Determine if the given argument is present. | from InteractsWithIO |
array|string|bool|null | argument(string|null $key = null)
Get the value of a command argument. | from InteractsWithIO |
array | arguments()
Get all of the arguments passed to the command. | from InteractsWithIO |
bool | hasOption(string $name)
Determine if the given option is present. | from InteractsWithIO |
string|array|bool|null | option(string|null $key = null)
Get the value of a command option. | from InteractsWithIO |
array | options()
Get all of the options passed to the command. | from InteractsWithIO |
bool | confirm(string $question, bool $default = false)
Confirm a question with the user. | from InteractsWithIO |
mixed | ask(string $question, string|null $default = null)
Prompt the user for input. | from InteractsWithIO |
mixed | anticipate(string $question, array|callable $choices, string|null $default = null)
Prompt the user for input with auto completion. | from InteractsWithIO |
mixed | askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Prompt the user for input with auto completion. | from InteractsWithIO |
mixed | secret(string $question, bool $fallback = true)
Prompt the user for input but hide the answer from the console. | from InteractsWithIO |
string|array | choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Give the user a single choice from an array of answers. | from InteractsWithIO |
void | table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Format input to textual table. | from InteractsWithIO |
mixed|void | withProgressBar(iterable|int $totalSteps, Closure $callback)
Execute a given callback while advancing a progress bar. | from InteractsWithIO |
void | info(string $string, int|string|null $verbosity = null)
Write a string as information output. | from InteractsWithIO |
void | line(string $string, string|null $style = null, int|string|null $verbosity = null)
Write a string as standard output. | from InteractsWithIO |
void | comment(string $string, int|string|null $verbosity = null)
Write a string as comment output. | from InteractsWithIO |
void | question(string $string, int|string|null $verbosity = null)
Write a string as question output. | from InteractsWithIO |
void | error(string $string, int|string|null $verbosity = null)
Write a string as error output. | from InteractsWithIO |
void | warn(string $string, int|string|null $verbosity = null)
Write a string as warning output. | from InteractsWithIO |
void | alert(string $string, int|string|null $verbosity = null)
Write a string in an alert box. | from InteractsWithIO |
$this | newLine(int $count = 1)
Write a blank line. | from InteractsWithIO |
void | setInput(InputInterface $input)
Set the input interface implementation. | from InteractsWithIO |
void | setOutput(OutputStyle $output)
Set the output interface implementation. | from InteractsWithIO |
void | setVerbosity(string|int $level)
Set the verbosity level. | from InteractsWithIO |
int | parseVerbosity(string|int|null $level = null)
Get the verbosity level in terms of Symfony's OutputInterface level. | from InteractsWithIO |
OutputStyle | getOutput()
Get the output implementation. | from InteractsWithIO |
void | trap(iterable<array-key,int>|int $signals, $callback)
Define a callback to be run when the given signal(s) occurs. | from InteractsWithSignals |
void | untrap()
Untrap signal handlers set within the command's handler. | from InteractsWithSignals |
void | interact(InputInterface $input, OutputInterface $output)
Interact with the user before validating the input. | from PromptsForMissingInput |
void | promptForMissingArguments(InputInterface $input, OutputInterface $output)
Prompt the user for any missing arguments. | from PromptsForMissingInput |
array | promptForMissingArgumentsUsing()
Prompt for missing input arguments using the returned questions. | from PromptsForMissingInput |
void | afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Perform actions after the user was prompted for missing arguments. | from PromptsForMissingInput |
bool | didReceiveOptions(InputInterface $input)
Whether the input contains any options that differ from the default values. | from PromptsForMissingInput |
static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
static void | flushMacros()
Flush the existing macros. | from Macroable |
static mixed | __callStatic(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
mixed | __call(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
void | __construct()
Create a new console command instance. | from Command |
void | configureUsingFluentDefinition()
Configure the console command using a fluent definition. | from Command |
void | configureIsolation()
Configure the console command for isolation. | from Command |
int | run(InputInterface $input, OutputInterface $output)
Run the console command. | from Command |
int | execute(InputInterface $input, OutputInterface $output)
Execute the console command. | from Command |
CommandMutex | commandIsolationMutex()
Get a command isolation mutex instance for the command. | from Command |
bool | isHidden() {@inheritdoc} | from Command |
Command | setHidden(bool $hidden = true) {@inheritdoc} | from Command |
Application | getLaravel()
Get the Laravel application instance. | from Command |
void | setLaravel(Container $laravel)
Set the Laravel application instance. | from Command |
void | handle(Schedule $schedule)
Execute the console command. |
Details
abstract protected Command resolveCommand(Command|string $command)
Resolve the console command instance for the given command.
int call(Command|string $command, array $arguments = [])
Call another console command.
int callSilent(Command|string $command, array $arguments = [])
Call another console command without output.
int callSilently(Command|string $command, array $arguments = [])
Call another console command without output.
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)
Run the given the console command.
protected ArrayInput createInputFromArguments(array $arguments)
Create an input instance from the given arguments.
protected array context()
Get all of the context passed to the command.
protected void specifyParameters()
Specify the arguments and options on the command.
protected array getArguments()
Get the console command arguments.
protected array getOptions()
Get the console command options.
bool hasArgument(string|int $name)
Determine if the given argument is present.
array|string|bool|null argument(string|null $key = null)
Get the value of a command argument.
array arguments()
Get all of the arguments passed to the command.
bool hasOption(string $name)
Determine if the given option is present.
string|array|bool|null option(string|null $key = null)
Get the value of a command option.
array options()
Get all of the options passed to the command.
bool confirm(string $question, bool $default = false)
Confirm a question with the user.
mixed ask(string $question, string|null $default = null)
Prompt the user for input.
mixed anticipate(string $question, array|callable $choices, string|null $default = null)
Prompt the user for input with auto completion.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Prompt the user for input with auto completion.
mixed secret(string $question, bool $fallback = true)
Prompt the user for input but hide the answer from the console.
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Give the user a single choice from an array of answers.
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Format input to textual table.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Execute a given callback while advancing a progress bar.
void info(string $string, int|string|null $verbosity = null)
Write a string as information output.
void line(string $string, string|null $style = null, int|string|null $verbosity = null)
Write a string as standard output.
void comment(string $string, int|string|null $verbosity = null)
Write a string as comment output.
void question(string $string, int|string|null $verbosity = null)
Write a string as question output.
void error(string $string, int|string|null $verbosity = null)
Write a string as error output.
void warn(string $string, int|string|null $verbosity = null)
Write a string as warning output.
void alert(string $string, int|string|null $verbosity = null)
Write a string in an alert box.
$this newLine(int $count = 1)
Write a blank line.
void setInput(InputInterface $input)
Set the input interface implementation.
void setOutput(OutputStyle $output)
Set the output interface implementation.
protected void setVerbosity(string|int $level)
Set the verbosity level.
protected int parseVerbosity(string|int|null $level = null)
Get the verbosity level in terms of Symfony's OutputInterface level.
OutputStyle getOutput()
Get the output implementation.
void trap(iterable<array-key,int>|int $signals, $callback)
Define a callback to be run when the given signal(s) occurs.
void untrap()
internal |
Untrap signal handlers set within the command's handler.
protected void interact(InputInterface $input, OutputInterface $output)
Interact with the user before validating the input.
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)
Prompt the user for any missing arguments.
protected array promptForMissingArgumentsUsing()
Prompt for missing input arguments using the returned questions.
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Perform actions after the user was prompted for missing arguments.
protected bool didReceiveOptions(InputInterface $input)
Whether the input contains any options that differ from the default values.
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
static void flushMacros()
Flush the existing macros.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
void __construct()
Create a new console command instance.
protected void configureUsingFluentDefinition()
Configure the console command using a fluent definition.
protected void configureIsolation()
Configure the console command for isolation.
int run(InputInterface $input, OutputInterface $output)
Run the console command.
protected int execute(InputInterface $input, OutputInterface $output)
Execute the console command.
protected CommandMutex commandIsolationMutex()
Get a command isolation mutex instance for the command.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Get the Laravel application instance.
void setLaravel(Container $laravel)
Set the Laravel application instance.
void handle(Schedule $schedule)
Execute the console command.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Console/Scheduling/ScheduleClearCacheCommand.html