CreateReportWidget
class Backend\Console\CreateReportWidget
extends System\Console\BaseScaffoldCommand
implements
Symfony\Component\Console\Command\SignalableCommandInterface
Extends
Class | Description |
---|---|
BaseScaffoldCommand
|
Traits
Trait | Description |
---|---|
HandlesCleanup
|
Console Command Trait that injects cross-platform signal handling to trigger cleanup on exit through the handleCleanup() method on the implementing class. |
HasPluginArgument
|
Console Command Trait that provides autocompletion for the "plugin" argument |
ProvidesAutocompletion
|
Console Command Trait that injects cross-platform signal handling to trigger cleanup on exit through the handleCleanup() method on the implementing class. |
Properties
protected
static
$defaultName
:
string
|
null
= "create:reportwidget"
The default command name for lazy loading.
protected
$description
:
string
= "Creates a new report widget."
The console command description.
protected
$nameFrom
:
string
= "widget"
The argument that the generated class name comes from
protected
$signature
:
string
= "create:reportwidget\n {plugin : The name of the plugin. <info>(eg: Winter.Blog)<\/info>}\n {widget : The name of the report widget to generate. <info>(eg: PostViews)<\/info>}\n {--force : Overwrite existing files with generated files.}\n {--uninspiring : Disable inspirational quotes}\n "
The name and signature of this command.
protected
$stubs
:
array
= {"scaffold\/reportwidget\/reportwidget.stub":"reportwidgets\/{{studly_name}}.php","scaffold\/reportwidget\/widget.stub":"reportwidgets\/{{lower_name}}\/partials\/_{{lower_name}}.php"}
A mapping of stub to generated file.
protected
$type
:
string
= "ReportWidget"
The type of class being generated.
inherited protected $files : Winter\Storm\Filesystem\Filesystem
The filesystem instance.
inherited protected $laravel : Winter\Storm\Foundation\Application
inherited
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
inherited
protected
$reservedNames
:
string[]
= ["__halt_compiler","abstract","and","array","as","break","callable","case","catch","class","clone","const","continue","declare","default","die","do","echo","else","elseif","empty","enddeclare","endfor","endforeach","endif","endswitch","endwhile","eval","exit","extends","final","finally","fn","for","foreach","function","global","goto","if","implements","include","include_once","instanceof","insteadof","interface","isset","list","namespace","new","or","print","private","protected","public","require","require_once","return","static","switch","throw","trait","try","unset","use","var","while","xor","yield"]
Reserved names that cannot be used for generation.
inherited
protected
$vars
:
array
= []
An array of variables to use in stubs.
Methods
inherited public __construct () : void
Create a new controller creator command instance.
inherited
public
alert (string $string, int | string | null $verbosity = null
)
: void
Write a string in an alert box.
Property | Type | Description |
---|---|---|
$string | string |
string
|
$verbosity | int | string | null |
int | string | null
|
inherited public complete (Symfony\Component\Console\Completion\CompletionInput $input, Symfony\Component\Console\Completion\CompletionSuggestions $suggestions) : void
Provide autocompletion for this command's input
Property | Type | Description |
---|---|---|
$input | Symfony\Component\Console\Completion\CompletionInput |
Symfony\Component\Console\Completion\CompletionInput
|
$suggestions | Symfony\Component\Console\Completion\CompletionSuggestions |
Symfony\Component\Console\Completion\CompletionSuggestions
|
inherited
public
error (string $string, int | string | null $verbosity = null
)
: void
Write a string as error output.
Property | Type | Description |
---|---|---|
$string | string |
string
|
$verbosity | int | string | null |
int | string | null
|
inherited
public
getPlugin ($identifier = null
)
: System\Classes\PluginBase | null
Get the plugin instance for the input.
Property | Type | Description |
---|---|---|
$identifier | mixed |
mixed
|
inherited
public
getPluginIdentifier ($identifier = null
)
: string
Get the desired plugin name from the input.
Property | Type | Description |
---|---|---|
$identifier | mixed |
mixed
|
inherited public getSubscribedSignals () : array
Returns the process signals this command listens to
inherited public handle () : int | bool | null
Execute the console command.
inherited public handleSignal (integer $signal) : void
Handle the provided Unix process signal
Property | Type | Description |
---|---|---|
$signal | integer |
integer
|
inherited public handleWindowsSignal (integer $event) : void
Handle the provided Windows process singal.
Property | Type | Description |
---|---|---|
$event | integer |
integer
|
inherited public makeStub (string $stubName)
Make a single stub.
Property | Type | Description |
---|---|---|
$stubName | string |
string
The source filename for the stub. |
inherited public makeStubs () : void
Make all stubs.
inherited public suggestPluginValues ()
Return available plugins for autocompletion of the "plugin" argument
inherited protected getDestinationForStub (string $stubName) : string
Get the destination path for the provided stub name
Property | Type | Description |
---|---|---|
$stubName | string |
string
|
inherited protected getDestinationPath () : string
Get the base path to output generated stubs to
inherited protected getLangKeys () : array
Gets the localization keys and values to be stored in the plugin's localization files Can reference $this->vars and $this->laravel->getLocale() internally
inherited protected getNameInput () : string
Get the desired class name from the input.
inherited protected getSourcePath () : string
Get the base path to source stub files from
inherited protected isReservedName (string $name) : bool
Checks whether the given name is reserved.
Property | Type | Description |
---|---|---|
$name | string |
string
|
inherited protected makeDirectory (string $path) : void
Build the directory for the class if necessary.
Property | Type | Description |
---|---|---|
$path | string |
string
|
inherited protected modifyString (string | array $type, string $string) : string
Internal helper that handles modify a string, with extra logic.
Property | Type | Description |
---|---|---|
$type | string | array |
string | array
|
$string | string |
string
|
inherited protected prepareVars () : array
Prepare variables for stubs.
inherited protected processVars (array $vars) : array
Converts all variables to available modifier and case formats and adds plugin helpers
Property | Type | Description |
---|---|---|
$vars | array |
array
|