CreateTheme

 class Cms\Console\CreateTheme
extends Winter\Storm\Scaffold\GeneratorCommand
implements 
    Symfony\Component\Console\Command\SignalableCommandInterface

Extends

Class Description
GeneratorCommand

Generator command.

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 static $defaultName : string | null

The default command name for lazy loading.

protected $description : string

The console command description.

protected $nameFrom : string

The argument that the generated class name comes from

protected $signature : string

The name and signature of this command.

protected $themeScaffolds : array

Available theme scaffolds and their types

protected $type : string

The type of class being generated.

inherited protected $files : Winter\Storm\Filesystem\Filesystem

Inherited from GeneratorCommand

The filesystem instance.

inherited protected $laravel : Winter\Storm\Foundation\Application

Inherited from Command

inherited protected $replaces : array

Inherited from Command

List of commands that this command replaces (aliases)

inherited protected $reservedNames : string[]

Inherited from GeneratorCommand

Reserved names that cannot be used for generation.

inherited protected $stubs : array

Inherited from GeneratorCommand

A mapping of stub to generated file.

inherited protected $vars : array

Inherited from GeneratorCommand

An array of variables to use in stubs.

Methods

public makeStub (string $stubName)

Make a single stub.

Parameters
Property Description
$stubName
string

The source filename for the stub.

Returns
mixed

public suggestScaffoldValues () : array

Auto suggest valid theme scaffold values

Returns
array

protected getDestinationPath () : string

Get the plugin path from the input.

Returns
string

protected getNameInput () : string

Get the desired class name from the input.

Returns
string

protected prepareVars () : array

Prepare variables for stubs.

Returns
array

inherited public __construct () : void

Inherited from GeneratorCommand

Create a new controller creator command instance.

Returns
void

inherited 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

inherited 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

inherited 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

inherited public getSubscribedSignals () : array

Inherited from HandlesCleanup

Returns the process signals this command listens to

Returns
array

inherited public handle () : int | bool | null

Inherited from GeneratorCommand

Execute the console command.

Returns
int | bool | null

inherited public handleSignal (integer $signal) : void

Inherited from HandlesCleanup

Handle the provided Unix process signal

Parameters
Property Description
$signal
integer
Returns
void

inherited public handleWindowsSignal (integer $event) : void

Inherited from HandlesCleanup

Handle the provided Windows process singal.

Parameters
Property Description
$event
integer
Returns
void

inherited public makeStubs () : void

Inherited from GeneratorCommand

Make all stubs.

Returns
void

inherited protected getDestinationForStub (string $stubName) : string

Inherited from GeneratorCommand

Get the destination path for the provided stub name

Parameters
Property Description
$stubName
string
Returns
string

inherited protected getSourcePath () : string

Inherited from GeneratorCommand

Get the base path to source stub files from

Returns
string

inherited protected isReservedName (string $name) : bool

Inherited from GeneratorCommand

Checks whether the given name is reserved.

Parameters
Property Description
$name
string
Returns
bool

inherited protected makeDirectory (string $path) : void

Inherited from GeneratorCommand

Build the directory for the class if necessary.

Parameters
Property Description
$path
string
Returns
void

inherited 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

inherited protected processVars (array $vars) : array

Inherited from GeneratorCommand

Converts all variables to available modifier and case formats.

Syntax is CASE_MODIFIER_KEY, eg: lower_plural_xxx

Parameters
Property Description
$vars
array
Returns
array
Copyright © 2024 Winter CMS