PluginEnable

Console command to enable a plugin.

 class System\Console\PluginEnable
extends Winter\Storm\Console\Command
implements 
    Symfony\Component\Console\Command\SignalableCommandInterface

Extends

Class Description
Command

Command base class Contains utilities to make developing CLI commands nicer

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

The default command name for lazy loading.

protected $description : string

The console command description.

protected $hasPluginsFilter : string

Only suggest plugins that are disabled

protected $signature : string

The name and signature of this command.

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)

Methods

public handle () : void

Execute the console command.

Returns
void

inherited public __construct ()

Inherited from Command

Create a new command instance.

Returns
mixed

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 getPlugin ($identifier = null) : System\Classes\PluginBase | null

Inherited from HasPluginArgument

Get the plugin instance for the input.

Parameters
Property Description
$identifier
mixed
Returns
System\Classes\PluginBase | null

inherited public getPluginIdentifier ($identifier = null) : string

Inherited from HasPluginArgument

Get the desired plugin name from the input.

Parameters
Property Description
$identifier
mixed
Returns
string

inherited public getSubscribedSignals () : array

Inherited from HandlesCleanup

Returns the process signals this command listens to

Returns
array

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 suggestPluginValues ()

Inherited from HasPluginArgument

Return available plugins for autocompletion of the "plugin" argument

Returns
mixed
Copyright © 2024 Winter CMS