class ControllerMakeCommand extends GeneratorCommand

Properties

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

void
__construct(Filesystem $files)

Create a new controller creator command instance.

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
bool
hasArgument(string|int $name)

Determine if the given argument is present.

from  Command
string|array
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
option(string $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
string
ask(string $question, string $default = null)

Prompt the user for input.

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

Prompt the user for input with auto completion.

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

Prompt the user for input with auto completion.

from  Command
string
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 $default = null, mixed $attempts = null, bool $multiple = null)

Give the user a single choice from an array of answers.

from  Command
void
table(array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

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

Write a string as information output.

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

Write a string as standard output.

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

Write a string as comment output.

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

Write a string as question output.

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

Write a string as error output.

from  Command
void
warn(string $string, null|int|string $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 $level = null)

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

from  Command
array
getArguments()

Get the console command arguments.

array
getOptions()

Get the console command options.

OutputInterface
getOutput()

Get the output implementation.

from  Command
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
fire()

Execute the console command.

string
qualifyClass(string $name)

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

string
getDefaultNamespace(string $rootNamespace)

Get the default namespace for the class.

bool
alreadyExists(string $rawName)

Determine if the class already exists.

string
getPath(string $name)

Get the destination class path.

string
makeDirectory(string $path)

Build the directory for the class if necessary.

string
buildClass(string $name)

Build the class with the given name.

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

Replace the namespace for the given stub.

string
getNamespace(string $name)

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

string
replaceClass(string $stub, string $name)

Replace the class name for the given stub.

string
getNameInput()

Get the desired class name from the input.

string
rootNamespace()

Get the root namespace for the class.

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

in GeneratorCommand at line 31
void __construct(Filesystem $files)

Create a new controller creator command instance.

Parameters

Filesystem $files

Return Value

void

in Command at line 120
protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

in Command at line 143
protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

in Command at line 164
int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

in Command at line 178
protected mixed execute(InputInterface $input, OutputInterface $output)

Execute the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

in Command at line 192
int call(string $command, array $arguments = [])

Call another console command.

Parameters

string $command
array $arguments

Return Value

int

in Command at line 208
int callSilent(string $command, array $arguments = [])

Call another console command silently.

Parameters

string $command
array $arguments

Return Value

int

in Command at line 223
bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int $name

Return Value

bool

in Command at line 234
string|array argument(string|null $key = null)

Get the value of a command argument.

Parameters

string|null $key

Return Value

string|array

in Command at line 248
array arguments()

Get all of the arguments passed to the command.

Return Value

array

in Command at line 259
bool hasOption(string $name)

Determine if the given option is present.

Parameters

string $name

Return Value

bool

in Command at line 270
string|array option(string $key = null)

Get the value of a command option.

Parameters

string $key

Return Value

string|array

in Command at line 284
array options()

Get all of the options passed to the command.

Return Value

array

in Command at line 296
bool confirm(string $question, bool $default = false)

Confirm a question with the user.

Parameters

string $question
bool $default

Return Value

bool

in Command at line 308
string ask(string $question, string $default = null)

Prompt the user for input.

Parameters

string $question
string $default

Return Value

string

in Command at line 321
string anticipate(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

in Command at line 334
string askWithCompletion(string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

in Command at line 350
string 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

string

in Command at line 369
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.

Parameters

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

Return Value

string

in Command at line 386
void table(array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
string $style

Return Value

void

in Command at line 404
void info(string $string, null|int|string $verbosity = null)

Write a string as information output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

in Command at line 417
void line(string $string, string $style = null, null|int|string $verbosity = null)

Write a string as standard output.

Parameters

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

Return Value

void

in Command at line 431
void comment(string $string, null|int|string $verbosity = null)

Write a string as comment output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

in Command at line 443
void question(string $string, null|int|string $verbosity = null)

Write a string as question output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

in Command at line 455
void error(string $string, null|int|string $verbosity = null)

Write a string as error output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

in Command at line 467
void warn(string $string, null|int|string $verbosity = null)

Write a string as warning output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

in Command at line 484
void alert(string $string)

Write a string in an alert box.

Parameters

string $string

Return Value

void

in Command at line 499
protected void setVerbosity(string|int $level)

Set the verbosity level.

Parameters

string|int $level

Return Value

void

in Command at line 510
protected int parseVerbosity(string|int $level = null)

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

Parameters

string|int $level

Return Value

int

in GeneratorCommand at line 227
protected array getArguments()

Get the console command arguments.

Return Value

array

at line 162
protected array getOptions()

Get the console command options.

Return Value

array

in Command at line 546
OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

in Command at line 556
Application getLaravel()

Get the Laravel application instance.

Return Value

Application

in Command at line 567
void setLaravel(Container $laravel)

Set the Laravel application instance.

Parameters

Container $laravel

Return Value

void

at line 38
protected string getStub()

Get the stub file for the generator.

Return Value

string

in GeneratorCommand at line 50
bool|null fire()

Execute the console command.

Return Value

bool|null

in GeneratorCommand at line 81
protected string qualifyClass(string $name)

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

Parameters

string $name

Return Value

string

at line 57
protected string getDefaultNamespace(string $rootNamespace)

Get the default namespace for the class.

Parameters

string $rootNamespace

Return Value

string

in GeneratorCommand at line 113
protected bool alreadyExists(string $rawName)

Determine if the class already exists.

Parameters

string $rawName

Return Value

bool

in GeneratorCommand at line 124
protected string getPath(string $name)

Get the destination class path.

Parameters

string $name

Return Value

string

in GeneratorCommand at line 137
protected string makeDirectory(string $path)

Build the directory for the class if necessary.

Parameters

string $path

Return Value

string

at line 70
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

in GeneratorCommand at line 166
protected $this replaceNamespace(string $stub, string $name)

Replace the namespace for the given stub.

Parameters

string $stub
string $name

Return Value

$this

in GeneratorCommand at line 183
protected string getNamespace(string $name)

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

Parameters

string $name

Return Value

string

in GeneratorCommand at line 195
protected string replaceClass(string $stub, string $name)

Replace the class name for the given stub.

Parameters

string $stub
string $name

Return Value

string

in GeneratorCommand at line 207
protected string getNameInput()

Get the desired class name from the input.

Return Value

string

in GeneratorCommand at line 217
protected string rootNamespace()

Get the root namespace for the class.

Return Value

string

at line 96
protected array buildParentReplacements()

Build the replacements for a parent controller.

Return Value

array

at line 119
protected array buildModelReplacements(array $replace)

Build the model replacement values.

Parameters

array $replace

Return Value

array

at line 142
protected string parseModel(string $model)

Get the fully-qualified model class name.

Parameters

string $model

Return Value

string