RuleMakeCommand
class RuleMakeCommand extends GeneratorCommand (View source)
Traits
| CallsCommands | |
| HasParameters | |
| InteractsWithIO | |
| Macroable |
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. | |
| protected string | $description | The console command description. | |
| 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. | from GeneratorCommand |
| protected string | $type | The type of class being generated. | |
| protected string[] | $reservedNames | Reserved names that cannot be used for generation. | from GeneratorCommand |
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 silently. | 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 |
| string|array|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|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, string $tableStyle = 'default', array $columnStyles = []) Format input to textual table. | 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) Write a string in an alert box. | from InteractsWithIO |
| void | 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 |
| 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 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(Filesystem $files) Create a new controller creator command instance. | from GeneratorCommand |
| void | configureUsingFluentDefinition() Configure the console command using a fluent definition. | 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 |
| isHidden() {@inheritdoc} | from Command | |
| setHidden(bool $hidden) {@inheritdoc} | from Command | |
| Application | getLaravel() Get the Laravel application instance. | from Command |
| void | setLaravel(Container $laravel) Set the Laravel application instance. | from Command |
| string | getStub() Get the stub file for the generator. | |
| bool|null | handle() Execute the console command. | from GeneratorCommand |
| string | qualifyClass(string $name) Parse the class name and format according to the root namespace. | from GeneratorCommand |
| string | qualifyModel(string $model) Qualify the given model class base name. | from GeneratorCommand |
| string | getDefaultNamespace(string $rootNamespace) Get the default namespace for the class. | |
| bool | alreadyExists(string $rawName) Determine if the class already exists. | from GeneratorCommand |
| string | getPath(string $name) Get the destination class path. | from GeneratorCommand |
| string | makeDirectory(string $path) Build the directory for the class if necessary. | from GeneratorCommand |
| string | buildClass(string $name) Build the class with the given name. | from GeneratorCommand |
| $this | replaceNamespace(string $stub, string $name) Replace the namespace for the given stub. | from GeneratorCommand |
| string | getNamespace(string $name) Get the full namespace for a given class, without the class name. | from GeneratorCommand |
| string | replaceClass(string $stub, string $name) Replace the class name for the given stub. | from GeneratorCommand |
| string | sortImports(string $stub) Alphabetically sorts the imports for the given stub. | from GeneratorCommand |
| string | getNameInput() Get the desired class name from the input. | from GeneratorCommand |
| string | rootNamespace() Get the root namespace for the class. | from GeneratorCommand |
| string|null | userProviderModel() Get the model for the default guard's user provider. | from GeneratorCommand |
| bool | isReservedName(string $name) Checks whether the given name is reserved. | from GeneratorCommand |
| string | viewPath(string $path = '') Get the first view directory path from the application configuration. | from GeneratorCommand |
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|array choice(string $question, array $choices, string|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, 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 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.
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 int execute(InputInterface $input, OutputInterface $output)
Execute the console command.
isHidden()
{@inheritdoc}
setHidden(bool $hidden)
{@inheritdoc}
Application getLaravel()
Get the Laravel application instance.
void setLaravel(Container $laravel)
Set the Laravel application instance.
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 qualifyModel(string $model)
Qualify the given model class base name.
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.
protected bool isReservedName(string $name)
Checks whether the given name is reserved.
protected string viewPath(string $path = '')
Get the first view directory path from the application configuration.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Foundation/Console/RuleMakeCommand.html