GeneratorCommand
abstract class GeneratorCommand extends Command (View source)
Traits
Properties
| 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 |
| 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. |
from Command |
| protected string|null | $description | The console command description. |
from Command |
| protected string|null | $help | The console command help text. |
from Command |
| $hidden | Indicates whether the command should be shown in the Artisan command list. |
from Command | |
| protected Filesystem | $files | The filesystem instance. |
|
| protected string | $type | The type of class being generated. |
Methods
Resolve the console command instance for the given command.
Call another console command.
Call another console command silently.
Run the given the console command.
Create an input instance from the given arguments.
Get the console command arguments.
Get the value of a command argument.
Get the value of a command option.
Confirm a question with the user.
Prompt the user for input.
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.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Configure the console command using a fluent definition.
Execute the console command.
Get the stub file for the generator.
Execute the console command.
Parse the class name and format according to the root namespace.
Get the default namespace for the class.
Determine if the class already exists.
Get the destination class path.
Build the directory for the class if necessary.
Build the class with the given name.
Replace the namespace for the given stub.
Get the full namespace for a given class, without the class name.
Replace the class name for the given stub.
Alphabetically sorts the imports for the given stub.
Get the desired class name from the input.
Get the root namespace for the class.
Get the model for the default guard's user provider.
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 silently.
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.
string|array|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
choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $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, 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)
Write a string in an alert box.
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.
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 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(Filesystem $files)
Create a new controller creator command instance.
protected void
configureUsingFluentDefinition()
Configure the console command using a fluent definition.
int
run(InputInterface $input, OutputInterface $output)
Run the console command.
protected mixed
execute(InputInterface $input, OutputInterface $output)
Execute the console command.
isHidden()
{@inheritdoc}
setHidden($hidden)
{@inheritdoc}
Application
getLaravel()
Get the Laravel application instance.
void
setLaravel(Container $laravel)
Set the Laravel application instance.
abstract protected string
getStub()
Get the stub file for the generator.
bool|null
handle()
Execute the console command.
protected string
qualifyClass(string $name)
Parse the class name and format according to the root namespace.
protected string
getDefaultNamespace(string $rootNamespace)
Get the default namespace for the class.
protected bool
alreadyExists(string $rawName)
Determine if the class already exists.
protected string
getPath(string $name)
Get the destination class path.
protected string
makeDirectory(string $path)
Build the directory for the class if necessary.
protected string
buildClass(string $name)
Build the class with the given name.
protected $this
replaceNamespace(string $stub, string $name)
Replace the namespace for the given stub.
protected string
getNamespace(string $name)
Get the full namespace for a given class, without the class name.
protected string
replaceClass(string $stub, string $name)
Replace the class name for the given stub.
protected string
sortImports(string $stub)
Alphabetically sorts the imports for the given stub.
protected string
getNameInput()
Get the desired class name from the input.
protected string
rootNamespace()
Get the root namespace for the class.
protected string|null
userProviderModel()
Get the model for the default guard's user provider.