BaseScaffoldCommand

abstract class System\Console\BaseScaffoldCommand
extends Winter\Storm\Scaffold\GeneratorCommand
implements 
    Symfony\Component\Console\Command\SignalableCommandInterface

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 $files : Winter\Storm\Filesystem\Filesystem

Inherited from GeneratorCommand

The filesystem instance.

protected $nameFrom : string

Inherited from GeneratorCommand

The argument that the generated class name comes from

protected $replaces : array

Inherited from Command

List of commands that this command replaces (aliases)

protected $reservedNames : string[]

Inherited from GeneratorCommand

Reserved names that cannot be used for generation.

protected $stubs : array

Inherited from GeneratorCommand

A mapping of stub to generated file.

protected $type : string

Inherited from GeneratorCommand

The type of class being generated.

protected $vars : array

Inherited from GeneratorCommand

An array of variables to use in stubs.

Methods

public makeStubs () : void

Make all stubs.

Returns
void

protected getDestinationPath () : string

Get the base path to output generated stubs to

Returns
string

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

Returns
array

protected prepareVars () : array

Prepare variables for stubs.

Returns
array

protected processVars (array $vars) : array

Converts all variables to available modifier and case formats and adds plugin helpers

Parameters
Property Description
$vars
array
Returns
array

public __construct () : void

Inherited from GeneratorCommand

Create a new controller creator command instance.

Returns
void

public alert (string $string, int | string | null $verbosity = null) : void

Inherited from Command

Write a string in an alert box.

Parameters
Property Description
$string
string
$verbosity
int | string | null
Returns
void

public complete (Symfony\Component\Console\Completion\CompletionInput $input, Symfony\Component\Console\Completion\CompletionSuggestions $suggestions) : void

Provide autocompletion for this command's input

Parameters
Property Description
$input
Symfony\Component\Console\Completion\CompletionInput
$suggestions
Symfony\Component\Console\Completion\CompletionSuggestions
Returns
void

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

Inherited from Command

Write a string as error output.

Parameters
Property Description
$string
string
$verbosity
int | string | null
Returns
void

public getPluginIdentifier ($identifier = null) : string

Inherited from HasPluginArgument

Get the desired plugin name from the input.

Parameters
Property Description
$identifier
mixed
Returns
string

public getSubscribedSignals () : array

Inherited from HandlesCleanup

Returns the process signals this command listens to

Returns
array

public handle () : bool | null

Inherited from GeneratorCommand

Execute the console command.

Returns
bool | null

public handleSignal (integer $signal) : integer | false

Inherited from HandlesCleanup

Handle the provided Unix process signal

Parameters
Property Description
$signal
integer
Returns
integer | false

public handleWindowsSignal (integer $event) : void

Inherited from HandlesCleanup

Handle the provided Windows process singal.

Parameters
Property Description
$event
integer
Returns
void

public makeStub (string $stubName)

Inherited from GeneratorCommand

Make a single stub.

Parameters
Property Description
$stubName
string

The source filename for the stub.

Returns
mixed

public suggestPluginValues ()

Inherited from HasPluginArgument

Return available plugins for autocompletion of the "plugin" argument

Returns
mixed

protected getDestinationForStub (string $stubName) : string

Inherited from GeneratorCommand

Get the destination path for the provided stub name

Parameters
Property Description
$stubName
string
Returns
string

protected getNameInput () : string

Inherited from GeneratorCommand

Get the desired class name from the input.

Returns
string

protected getSourcePath () : string

Inherited from GeneratorCommand

Get the base path to source stub files from

Returns
string

protected isReservedName (string $name) : bool

Inherited from GeneratorCommand

Checks whether the given name is reserved.

Parameters
Property Description
$name
string
Returns
bool

protected makeDirectory (string $path) : void

Inherited from GeneratorCommand

Build the directory for the class if necessary.

Parameters
Property Description
$path
string
Returns
void

protected modifyString (string | array $type, string $string) : string

Inherited from GeneratorCommand

Internal helper that handles modify a string, with extra logic.

Parameters
Property Description
$type
string | array
$string
string
Returns
string
Copyright © 2024 Winter CMS