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

The console command description.

protected $name : mixed

The console command name.

protected $replaces : array

List of commands that this command replaces (aliases)

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

Inherited from Command

Methods

public __construct ()

Create a new command instance.

Returns
mixed

public handle ()

Execute the console command.

Returns
mixed

protected askToInstallPlugins ()

Returns
mixed

protected displayIntro ()

Returns
mixed

protected displayOutro ()

Returns
mixed

protected getConfigFile (string $name = "app") : array

Get a config file and contents.

Parameters
Property Description
$name
string
Returns
array

protected getKeyLength (string $cipher) : int

Returns the supported length of a key for a cipher.

Parameters
Property Description
$cipher
string
Returns
int

protected getOptions () : array

Get the console command options.

Returns
array

protected getRandomKey (string $cipher) : string

Generate a random key for the application.

Parameters
Property Description
$cipher
string
Returns
string

protected setupAdminUser ()

Returns
mixed

protected setupAdvancedValues ()

Returns
mixed

protected setupBackendValues ()

Returns
mixed

protected setupCommonValues ()

Returns
mixed

protected setupDatabaseConfig ()

Returns
mixed

protected setupDatabaseMysql ()

Returns
mixed

protected setupDatabasePgsql ()

Returns
mixed

protected setupDatabaseSqlite ()

Returns
mixed

protected setupDatabaseSqlsrv ()

Returns
mixed

protected setupEncryptionKey (boolean $force = false)

Parameters
Property Description
$force
boolean
Returns
mixed

protected setupMigrateDatabase ()

Returns
mixed

protected writeToConfig ($file, $values)

Parameters
Property Description
$file
mixed
$values
mixed
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 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
Copyright © 2024 Winter CMS