PHP Class Devise\Support\Console\DeviseInstallCommand

Inheritance: extends Command
Datei anzeigen Open project: devisephp/cms

Public Properties

Property Type Description
$envMock Mockery Mocks the environment
$io Devise\Support\Console\DeviseInstallCommand This input output object for writing to console
$wizard Devise\Support\Installer\InstallWizard The Devise install wizard

Protected Properties

Property Type Description
$description Necessary to let people know, in case the name wasn't clear enough.
$name Name of the command.

Public Methods

Method Description
__construct ( Illuminate\Container\Container $app ) Setup the application container as we'll need this for running migrations.
changeDatabaseConfigFile ( ) : void Changes the default out of the box Laravel database config to include other env() settings that we will use in Devise such as 'default' and we also update the sqlite driver stuff
changeEmailConfigFile ( ) : void Changes the email config file out of the box to include devise as the password reminder view instead of the other view
handle ( ) Run the package migrations.
runInstallCommands ( ) : void Runs the install commands for migrations, seeds, publishing assets and configs

Protected Methods

Method Description
askAboutDatabaseHost ( [type] $default ) : [type] [askAboutDatabaseHost description]
askAboutDatabaseMigrations ( boolean $default ) : boolean Prompt for executing database migrations
askAboutDatabaseName ( [type] $default ) : [type] [askAboutDatabaseName description]
askAboutDatabasePass ( [type] $default ) : [type] [askAboutDatabasePass description]
askAboutDatabaseSeeds ( boolean $default ) : boolean Prompt for executing database seeds
askAboutDatabaseType ( $default ) : [type] [askAboutDatabase description]
askAboutDatabaseUser ( [type] $default ) : [type] [askAboutDatabaseUser description]
env ( [type] $setting, [type] $default = null ) : [type] [env description]
io ( ) : DeviseInstallCommand The input output handler (used this way for mocking)
runApplicationMigrations ( ) : void Runs the application migrations
runApplicationSeeds ( ) : void Runs the application seeds
setupAdminUser ( ) : [type] [setupAdminUser description]
setupAppName ( ) : [type] [setupAppName description]
setupConfigOverrides ( ) : [type] [setupConfigOverrides description]
setupDatabase ( ) : [type] [setupDatabase description]
setupEnvironment ( ) : [type] [askAboutEnvironment description]
spitOutErrors ( [type] $messages ) : [type] [spitOutErrors description]
wizard ( ) : InstallWizard The wizard for the installer

Method Details

__construct() public method

Setup the application container as we'll need this for running migrations.
public __construct ( Illuminate\Container\Container $app )
$app Illuminate\Container\Container

askAboutDatabaseHost() protected method

[askAboutDatabaseHost description]
protected askAboutDatabaseHost ( [type] $default ) : [type]
$default [type]
return [type]

askAboutDatabaseMigrations() protected method

Prompt for executing database migrations
protected askAboutDatabaseMigrations ( boolean $default ) : boolean
$default boolean
return boolean

askAboutDatabaseName() protected method

[askAboutDatabaseName description]
protected askAboutDatabaseName ( [type] $default ) : [type]
$default [type]
return [type]

askAboutDatabasePass() protected method

[askAboutDatabasePass description]
protected askAboutDatabasePass ( [type] $default ) : [type]
$default [type]
return [type]

askAboutDatabaseSeeds() protected method

Prompt for executing database seeds
protected askAboutDatabaseSeeds ( boolean $default ) : boolean
$default boolean
return boolean

askAboutDatabaseType() protected method

[askAboutDatabase description]
protected askAboutDatabaseType ( $default ) : [type]
return [type]

askAboutDatabaseUser() protected method

[askAboutDatabaseUser description]
protected askAboutDatabaseUser ( [type] $default ) : [type]
$default [type]
return [type]

changeDatabaseConfigFile() public method

Changes the default out of the box Laravel database config to include other env() settings that we will use in Devise such as 'default' and we also update the sqlite driver stuff
public changeDatabaseConfigFile ( ) : void
return void

changeEmailConfigFile() public method

Changes the email config file out of the box to include devise as the password reminder view instead of the other view
public changeEmailConfigFile ( ) : void
return void

env() protected method

[env description]
protected env ( [type] $setting, [type] $default = null ) : [type]
$setting [type]
$default [type]
return [type]

handle() public method

Run the package migrations.
public handle ( )

io() protected method

The input output handler (used this way for mocking)
protected io ( ) : DeviseInstallCommand
return DeviseInstallCommand

runApplicationMigrations() protected method

Runs the application migrations
protected runApplicationMigrations ( ) : void
return void

runApplicationSeeds() protected method

Runs the application seeds
protected runApplicationSeeds ( ) : void
return void

runInstallCommands() public method

Runs the install commands for migrations, seeds, publishing assets and configs
public runInstallCommands ( ) : void
return void

setupAdminUser() protected method

[setupAdminUser description]
protected setupAdminUser ( ) : [type]
return [type]

setupAppName() protected method

[setupAppName description]
protected setupAppName ( ) : [type]
return [type]

setupConfigOverrides() protected method

[setupConfigOverrides description]
protected setupConfigOverrides ( ) : [type]
return [type]

setupDatabase() protected method

[setupDatabase description]
protected setupDatabase ( ) : [type]
return [type]

setupEnvironment() protected method

[askAboutEnvironment description]
protected setupEnvironment ( ) : [type]
return [type]

spitOutErrors() protected method

[spitOutErrors description]
protected spitOutErrors ( [type] $messages ) : [type]
$messages [type]
return [type]

wizard() protected method

The wizard for the installer
protected wizard ( ) : InstallWizard
return InstallWizard

Property Details

$description protected_oe property

Necessary to let people know, in case the name wasn't clear enough.
protected $description

$envMock public_oe property

Mocks the environment
public Mockery $envMock
return Mockery

$io public_oe property

This input output object for writing to console
public Devise\Support\Console\DeviseInstallCommand $io
return Devise\Support\Console\DeviseInstallCommand

$name protected_oe property

Name of the command.
protected $name

$wizard public_oe property

The Devise install wizard
public Devise\Support\Installer\InstallWizard $wizard
return Devise\Support\Installer\InstallWizard