InstallShoutzor
extends Command
in package
An Artisan command allowing for command-line installation of Shoutzor.
The Functionality of this installer is identical to the graphical installer of Shoutzor.
Table of Contents
- $description : string
- The console command description.
- $signature : string
- The name and signature of the console command.
- $installer : Installer
- Instance of the Installer class
- __construct() : void
- Create a new command instance.
- handle() : int
- Runs the shoutzor install command.
- checkHealth() : mixed
- Runs the healthchecks and will perform an auto-fix if any issues are detected
- configureDbConnection() : mixed
- loadEnvFile() : mixed
- performInstall() : mixed
- Performs the actual installation of Shoutzor
- testDbHostConnection() : mixed
- testDbLogin() : mixed
Properties
$description
The console command description.
protected
string
$description
= 'Installs Shoutz0r via the command line'
$signature
The name and signature of the console command.
protected
string
$signature
= 'shoutzor:install {--useenv} {--dev}'
--useenv indicates that the existing .env file should be used during installation. --dev indicates that this is a development environment and will populate the database with dummy data
$installer
Instance of the Installer class
private
Installer
$installer
Methods
__construct()
Create a new command instance.
public
__construct() : void
Return values
void —handle()
Runs the shoutzor install command.
public
handle() : int
This will execute the same steps as the graphical installation wizard.
Return values
int —checkHealth()
Runs the healthchecks and will perform an auto-fix if any issues are detected
private
checkHealth() : mixed
Tags
Return values
mixed —configureDbConnection()
private
configureDbConnection(mixed $useEnv, mixed $dbFields) : mixed
Parameters
- $useEnv : mixed
- $dbFields : mixed
Return values
mixed —loadEnvFile()
private
loadEnvFile() : mixed
Return values
mixed —performInstall()
Performs the actual installation of Shoutzor
private
performInstall(mixed $useEnv, mixed $isDev) : mixed
Parameters
- $useEnv : mixed
- $isDev : mixed
Tags
Return values
mixed —testDbHostConnection()
private
testDbHostConnection(mixed $host, mixed $port) : mixed
Parameters
- $host : mixed
- $port : mixed
Return values
mixed —testDbLogin()
private
testDbLogin(mixed $dbtype, mixed $host, mixed $port, mixed $database, mixed $username, mixed $password) : mixed
Parameters
- $dbtype : mixed
- $host : mixed
- $port : mixed
- $database : mixed
- $username : mixed
- $password : mixed