Command
Command base class
Contains utilities to make developing CLI commands nicer
abstract class Winter\Storm\Console\Command
extends Illuminate\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterfaceExtends
| Class | Description |
|---|---|
Illuminate\Console\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 $laravel : Winter\Storm\Foundation\Application
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
Methods
public __construct ()
Create a new command instance.
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
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 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 getSubscribedSignals () : array
Returns the process signals this command listens to
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
|
Extended by
| Class | Description |
|---|---|
PluginDisable
|
Console command to disable a plugin. |
PluginEnable
|
Console command to enable a plugin. |
PluginInstall
|
Console command to install a new plugin. |
PluginList
|
Console command to list existing plugins. |
PluginRefresh
|
Console command to refresh a plugin. |
PluginRemove
|
Console command to remove a plugin. |
PluginRollback
|
Console command to rollback a plugin. |
WinterDown
|
Console command to tear down the database. |
WinterEnv
|
Console command to convert configuration to use .env files. |
WinterInstall
|
Console command to install Winter. |
WinterVersion
|
Detects the version of Winter CMS installed. |
AssetCompile
|
|
AssetCreate
|
|
AssetInstall
|
|
AssetList
|
|
NpmRun
|
|
UserCreate
|
|
WinterPasswd
|
Console command to change the password of a Backend user via CLI. |
ThemeInstall
|
Console command to install a new theme. |
ThemeList
|
Console command to list themes. |
ThemeRemove
|
Console command to remove a theme. |
ThemeSync
|
Console command to sync a theme between the DB and Filesystem layers. |
ThemeUse
|
Console command to switch themes. |
GeneratorCommand
|
Generator command. |