EnvironmentCommand
class EnvironmentCommand extends Command (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Application | $laravel | The Laravel application instance. |
from Command |
| protected InputInterface | $input | The input interface implementation. |
from Command |
| protected OutputStyle | $output | The output interface implementation. |
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. |
|
| $hidden | Indicates whether the command should be shown in the Artisan command list. |
from Command | |
| protected int | $verbosity | The default verbosity of output commands. |
from Command |
| protected array | $verbosityMap | The mapping between human readable verbosity levels and Symfony's OutputInterface. |
from Command |
Methods
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Configure the console command using a fluent definition.
Execute the console command.
Call another console command silently.
Create an input instance from the given arguments.
Confirm a question with the user.
Prompt the user for input with auto completion.
Prompt the user for input with auto completion.
Prompt the user for input but hide the answer from the console.
Give the user a single choice from an array of answers.
Format input to textual table.
Write a string as information output.
Write a string as standard output.
Write a string as comment output.
Write a string as question output.
Write a string as error output.
Write a string as warning output.
Get the verbosity level in terms of Symfony's OutputInterface level.
Execute the console command.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
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
specifyParameters()
Specify the arguments and options on the command.
int
run(InputInterface $input, OutputInterface $output)
Run the console command.
protected mixed
execute(InputInterface $input, OutputInterface $output)
Execute the console command.
int
call(string $command, array $arguments = [])
Call another console command.
int
callSilent(string $command, array $arguments = [])
Call another console command silently.
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.
bool
hasArgument(string|int $name)
Determine if the given argument is present.
string|array
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
option(string $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.
string
ask(string $question, string $default = null)
Prompt the user for input.
string
anticipate(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
string
askWithCompletion(string $question, array $choices, string $default = null)
Prompt the user for input with auto completion.
string
secret(string $question, bool $fallback = true)
Prompt the user for input but hide the answer from the console.
string
choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)
Give the user a single choice from an array of answers.
void
table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Format input to textual table.
void
info(string $string, null|int|string $verbosity = null)
Write a string as information output.
void
line(string $string, string $style = null, null|int|string $verbosity = null)
Write a string as standard output.
void
comment(string $string, null|int|string $verbosity = null)
Write a string as comment output.
void
question(string $string, null|int|string $verbosity = null)
Write a string as question output.
void
error(string $string, null|int|string $verbosity = null)
Write a string as error output.
void
warn(string $string, null|int|string $verbosity = null)
Write a string as warning output.
void
alert(string $string)
Write a string in an alert box.
protected void
setVerbosity(string|int $level)
Set the verbosity level.
protected int
parseVerbosity(string|int $level = null)
Get the verbosity level in terms of Symfony's OutputInterface level.
protected array
getArguments()
Get the console command arguments.
protected array
getOptions()
Get the console command options.
OutputInterface
getOutput()
Get the output implementation.
Application
getLaravel()
Get the Laravel application instance.
void
setLaravel(Container $laravel)
Set the Laravel application instance.
void
handle()
Execute the console command.