ControllerMakeCommand

class ControllerMakeCommand extends GeneratorCommand (View source)

Traits

Macroable

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.
protected bool $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
protected Filesystem $files The filesystem instance. from GeneratorCommand
protected string $type The type of class being generated.

Methods

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

Register a custom macro.

 from Macroable
static void mixin(object $mixin)

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

Specify the arguments and options on the command.

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

Run the console command.

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

Execute the console command.

 from Command
int call(string $command, array $arguments = [])

Call another console command.

 from Command
int callSilent(string $command, array $arguments = [])

Call another console command silently.

 from Command
ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

 from Command
bool hasArgument(string|int $name)

Determine if the given argument is present.

 from Command
string|array|null argument(string|null $key = null)

Get the value of a command argument.

 from Command
array arguments()

Get all of the arguments passed to the command.

 from Command
bool hasOption(string $name)

Determine if the given option is present.

 from Command
string|array|null option(string|null $key = null)

Get the value of a command option.

 from Command
array options()

Get all of the options passed to the command.

 from Command
bool confirm(string $question, bool $default = false)

Confirm a question with the user.

 from Command
mixed ask(string $question, string|null $default = null)

Prompt the user for input.

 from Command
mixed anticipate(string $question, array $choices, string|null $default = null)

Prompt the user for input with auto completion.

 from Command
mixed askWithCompletion(string $question, array $choices, string|null $default = null)

Prompt the user for input with auto completion.

 from Command
mixed secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

 from Command
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.

 from Command
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

 from Command
void info(string $string, int|string|null $verbosity = null)

Write a string as information output.

 from Command
void line(string $string, string $style = null, int|string|null $verbosity = null)

Write a string as standard output.

 from Command
void comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

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

Write a string as question output.

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

Write a string as error output.

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

Write a string as warning output.

 from Command
void alert(string $string)

Write a string in an alert box.

 from Command
void setVerbosity(string|int $level)

Set the verbosity level.

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

Get the verbosity level in terms of Symfony's OutputInterface level.

 from Command
array getArguments()

Get the console command arguments.

 from GeneratorCommand
array getOptions()

Get the console command options.
OutputStyle getOutput()

Get the output implementation.

 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 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.
$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 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
array buildParentReplacements()

Build the replacements for a parent controller.
array buildModelReplacements(array $replace)

Build the model replacement values.
string parseModel(string $model)

Get the fully-qualified model class name.

Details

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

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Filesystem $files)

Create a new controller creator command instance.

Parameters

Filesystem $files

Return Value

void

protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected mixed execute(InputInterface $input, OutputInterface $output)

Execute the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

int call(string $command, array $arguments = [])

Call another console command.

Parameters

string $command
array $arguments

Return Value

int

int callSilent(string $command, array $arguments = [])

Call another console command silently.

Parameters

string $command
array $arguments

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

Parameters

array $arguments

Return Value

ArrayInput

bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

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

Get the value of a command argument.

Parameters

string|null $key

Return Value

string|array|null

array arguments()

Get all of the arguments passed to the command.

Return Value

array

bool hasOption(string $name)

Determine if the given option is present.

Parameters

string $name

Return Value

bool

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

Get the value of a command option.

Parameters

string|null $key

Return Value

string|array|null

array options()

Get all of the options passed to the command.

Return Value

array

bool confirm(string $question, bool $default = false)

Confirm a question with the user.

Parameters

string $question
bool $default

Return Value

bool

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

Prompt the user for input.

Parameters

string $question
string|null $default

Return Value

mixed

mixed anticipate(string $question, array $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

mixed askWithCompletion(string $question, array $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

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

Prompt the user for input but hide the answer from the console.

Parameters

string $question
bool $fallback

Return Value

mixed

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.

Parameters

string $question
array $choices
string|null $default
mixed|null $attempts
bool|null $multiple

Return Value

string

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

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
string $tableStyle
array $columnStyles

Return Value

void

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

Write a string as information output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

Write a string as standard output.

Parameters

string $string
string $style
int|string|null $verbosity

Return Value

void

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

Write a string as comment output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

Write a string as question output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

Write a string as error output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

Write a string as warning output.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void alert(string $string)

Write a string in an alert box.

Parameters

string $string

Return Value

void

protected void setVerbosity(string|int $level)

Set the verbosity level.

Parameters

string|int $level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

Parameters

string|int|null $level

Return Value

int

protected array getArguments()

Get the console command arguments.

Return Value

array

protected array getOptions()

Get the console command options.

Return Value

array

OutputStyle getOutput()

Get the output implementation.

Return Value

OutputStyle

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel(Container $laravel)

Set the Laravel application instance.

Parameters

Container $laravel

Return Value

void

protected string getStub()

Get the stub file for the generator.

Return Value

string

bool|null handle()

Execute the console command.

Return Value

bool|null

protected string qualifyClass(string $name)

Parse the class name and format according to the root namespace.

Parameters

string $name

Return Value

string

protected string getDefaultNamespace(string $rootNamespace)

Get the default namespace for the class.

Parameters

string $rootNamespace

Return Value

string

protected bool alreadyExists(string $rawName)

Determine if the class already exists.

Parameters

string $rawName

Return Value

bool

protected string getPath(string $name)

Get the destination class path.

Parameters

string $name

Return Value

string

protected string makeDirectory(string $path)

Build the directory for the class if necessary.

Parameters

string $path

Return Value

string

protected string buildClass(string $name)

Build the class with the given name.

Remove the base controller import if we are already in base namespace.

Parameters

string $name

Return Value

string

protected $this replaceNamespace(string $stub, string $name)

Replace the namespace for the given stub.

Parameters

string $stub
string $name

Return Value

$this

protected string getNamespace(string $name)

Get the full namespace for a given class, without the class name.

Parameters

string $name

Return Value

string

protected string replaceClass(string $stub, string $name)

Replace the class name for the given stub.

Parameters

string $stub
string $name

Return Value

string

protected string getNameInput()

Get the desired class name from the input.

Return Value

string

protected string rootNamespace()

Get the root namespace for the class.

Return Value

string

protected string|null userProviderModel()

Get the model for the default guard's user provider.

Return Value

string|null

protected array buildParentReplacements()

Build the replacements for a parent controller.

Return Value

array

protected array buildModelReplacements(array $replace)

Build the model replacement values.

Parameters

array $replace

Return Value

array

protected string parseModel(string $model)

Get the fully-qualified model class name.

Parameters

string $model

Return Value

string

Exceptions

InvalidArgumentException

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Routing/Console/ControllerMakeCommand.html