PluginRemove
Console command to remove a plugin.
class System\Console\PluginRemove
extends Winter\Storm\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterface
This completely deletes an existing plugin, including database tables, files and directories.
Extends
Class | Description |
---|---|
Command
|
Command base class Contains utilities to make developing CLI commands nicer |
Traits
Trait | Description |
---|---|
ConfirmsWithInput
|
Console Command Trait that provides confirmation step that requires set input to be provided in order to act as confirmation for an action |
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
= "plugin:remove"
The default command name for lazy loading.
protected
$description
:
string
= "Removes an existing plugin."
The console command description.
protected
$hasPluginsFilter
:
string
= "all"
Suggest all plugins
protected
$signature
:
string
= "plugin:remove\n {plugin : The plugin to remove. <info>(eg: Winter.Blog)<\/info>}\n {--f|force : Force the operation to run and ignore production warnings and confirmation questions.}\n {--r|no-rollback : Skip the rollback of the plugin migrations.}"
The name and signature of this command.
inherited protected $laravel : Winter\Storm\Foundation\Application
inherited
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
Methods
public handle () : integer
Execute the console command.
inherited public __construct ()
Create a new 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 confirmWithInput (string $message, string $requiredInput) : bool
Property | Type | Description |
---|---|---|
$message | string |
string
|
$requiredInput | string |
string
|
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 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 suggestPluginValues ()
Return available plugins for autocompletion of the "plugin" argument