WinterPasswd
Console command to change the password of a Backend user via CLI.
class Backend\Console\WinterPasswd
extends Winter\Storm\Console\Command
implements
Symfony\Component\Console\Command\SignalableCommandInterfaceTraits
| 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
static
$defaultName
:
string
|
null
= "winter:passwd"
The default command name for lazy loading.
protected
$description
:
string
= "Change the password of a Backend user."
The console command description.
protected
$generatedPassword
:
bool
= false
Was the password automatically generated?
protected
$replaces
:
array
= ["winter:password"]
List of commands that this command replaces (aliases)
protected
$signature
:
string
= "winter:passwd\n {username? : The username or email of the Backend user. <info>(eg: admin or admin@example.com)<\/info>}\n {password? : The new password to set.}"
The name and signature of this command.
Methods
public __construct ()
Create a new command instance.
public handle () : int
Execute the console command.
public suggestUsernameValues () : array
Return the 20 most recently updated users for autocompletion of the "username" argument
protected generatePassword () : string
Generate a password and flag it as an automatically-generated password.
protected
optionalSecret (string $question, boolean $fallback = true, $default = null)
: string
Prompt the user for input but hide the answer from the console.
Also allows for a default to be specified.
| Property | Type | Description |
|---|---|---|
| $question | string |
string
|
| $fallback | boolean |
boolean
|
| $default | mixed |
mixed
|
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
|