WinterInstall
Console command to install Winter.
class System\Console\WinterInstall
extends Winter\Storm\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterface
This sets up Winter for the first time. It will prompt the user for several configuration items, including application URL and database config, and then perform a database migration.
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. |
Illuminate\Console\ConfirmableTrait
|
|
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 $configWriter : Winter\Storm\Config\ConfigWriter
protected
$description
:
mixed
= "Set up Winter for the first time."
The console command description.
protected
$name
:
mixed
= "winter:install"
The console command name.
protected
$replaces
:
array
= ["october:install"]
List of commands that this command replaces (aliases)
inherited protected $laravel : Winter\Storm\Foundation\Application
Methods
public __construct ()
Create a new command instance.
public handle ()
Execute the console command.
protected askToInstallPlugins ()
protected displayIntro ()
protected displayOutro ()
protected
getConfigFile (string $name = "app")
: array
Get a config file and contents.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
protected getKeyLength (string $cipher) : int
Returns the supported length of a key for a cipher.
| Property | Type | Description |
|---|---|---|
| $cipher | string |
string
|
protected getOptions () : array
Get the console command options.
protected getRandomKey (string $cipher) : string
Generate a random key for the application.
| Property | Type | Description |
|---|---|---|
| $cipher | string |
string
|
protected setupAdminUser ()
protected setupAdvancedValues ()
protected setupBackendValues ()
protected setupCommonValues ()
protected setupDatabaseConfig ()
protected setupDatabaseMysql ()
protected setupDatabasePgsql ()
protected setupDatabaseSqlite ()
protected setupDatabaseSqlsrv ()
protected
setupEncryptionKey (boolean $force = false)
| Property | Type | Description |
|---|---|---|
| $force | boolean |
boolean
|
protected setupMigrateDatabase ()
protected writeToConfig ($file, $values)
| Property | Type | Description |
|---|---|---|
| $file | mixed |
mixed
|
| $values | mixed |
mixed
|
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
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 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
|