WinterEnv
Console command to convert configuration to use .env files.
class System\Console\WinterEnv
extends Winter\Storm\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterfaceThis creates an .env file with some default configuration values, it also converts
the existing PHP-based configuration files to use the env function for values.
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
$description
:
mixed
= "Creates .env file with default configuration values."
The console command description.
protected
$name
:
mixed
= "winter:env"
The console command name.
protected
$protectedKeys
:
array
= ["APP_KEY","DB_USERNAME","DB_PASSWORD","MAIL_USERNAME","MAIL_PASSWORD","REDIS_PASSWORD"]
The env keys that need to have their original values removed from the config files
protected
$replaces
:
array
= []
List of commands that this command replaces (aliases)
Methods
public __construct ()
Create a new command instance.
public
confirmToProceed (string $warning = "Application In Production!", Closure | bool | null $callback = null)
: bool
Confirm before proceeding with the action.
This method only asks for confirmation in production.
| Property | Type | Description |
|---|---|---|
| $warning | string |
string
|
| $callback | Closure | bool | null |
Closure | bool | null
|
public handle () : integer
Execute the console command.
protected config () : array
Returns a map of env keys to php config keys for db configs
protected dbConfig () : array
Returns a map of env keys to php config keys for db configs
protected getConfigPath (string $config) : string
Get the full path of a config file
| Property | Type | Description |
|---|---|---|
| $config | string |
string
|
protected getKeyValuePair (string $envKey, string $configKey) : array
Returns an array containing the key as the first element and the value as the second if the key is not a protected key; otherwise the value will be an empty string
| Property | Type | Description |
|---|---|---|
| $envKey | string |
string
|
| $configKey | string |
string
|
protected mailConfig () : array
Returns a map of env keys to php config keys for mail configs
protected updateConfigFiles () : void
Update config files with env function calls
protected updateEnvFile () : void
Set env keys to their config values within the EnvFile object
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 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
|
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
|
public getSubscribedSignals () : array
Returns the process signals this command listens to
public handleSignal (integer $signal) : integer | false
Handle the provided Unix process signal
| Property | Type | Description |
|---|---|---|
| $signal | integer |
integer
|
public handleWindowsSignal (integer $event) : void
Handle the provided Windows process singal.
| Property | Type | Description |
|---|---|---|
| $event | integer |
integer
|