GeneratorCommand
Generator command.
abstract class Winter\Storm\Scaffold\GeneratorCommand
extends Winter\Storm\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterfaceThis class is used as a base for scaffolding commands, modifying stub files and copying them over to a specific location.
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. |
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 $files : Winter\Storm\Filesystem\Filesystem
The filesystem instance.
protected
$nameFrom
:
string
= "name"
The argument that the generated class name comes from
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.
protected
$stubs
:
array
= []
A mapping of stub to generated file.
protected $type : string
The type of class being generated.
protected
$vars
:
array
= []
An array of variables to use in stubs.
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
Methods
public __construct () : void
Create a new controller creator command instance.
public handle () : bool | null
Execute the console command.
public makeStub (string $stubName)
Make a single stub.
| Property | Type | Description |
|---|---|---|
| $stubName | string |
string
The source filename for the stub. |
public makeStubs () : void
Make all stubs.
protected getDestinationForStub (string $stubName) : string
Get the destination path for the provided stub name
| Property | Type | Description |
|---|---|---|
| $stubName | string |
string
|
protected getDestinationPath () : string
Get the base path to output generated stubs to
protected getNameInput () : string
Get the desired class name from the input.
protected getSourcePath () : string
Get the base path to source stub files from
protected isReservedName (string $name) : bool
Checks whether the given name is reserved.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
protected makeDirectory (string $path) : void
Build the directory for the class if necessary.
| Property | Type | Description |
|---|---|---|
| $path | string |
string
|
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
|
protected prepareVars () : array
Prepare variables for stubs.
protected processVars (array $vars) : array
Converts all variables to available modifier and case formats.
Syntax is CASE_MODIFIER_KEY, eg: lower_plural_xxx
| Property | Type | Description |
|---|---|---|
| $vars | array |
array
|
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
|
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
|
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
|
public getSubscribedSignals () : array
Returns the process signals this command listens to
public handleSignal (integer $signal) : integer | false
Handle the provided Unix process signal
| Property | Type | Description |
|---|---|---|
| $signal | integer |
integer
|
public handleWindowsSignal (integer $event) : void
Handle the provided Windows process singal.
| Property | Type | Description |
|---|---|---|
| $event | integer |
integer
|