ConfigurationDatabase
in package
Manages the configuration persistence.
Table of Contents
- TABLE_MAIN_CONFIG = 'main_configuration'
- table for main configuration
- TABLE_SCHEMA_VERSIONS = 'schema_versions'
- table for schema versions
- ROW_VERSION_MAIN_CONFIG = 'main_configuration'
- row name for main config schema version
- ROW_VERSION_SYSTEM = 'system'
- row name for system schema version
- $cfgMain : mixed
- $pdo : PDO
- __construct() : mixed
- Constructor
- checkConnection() : mixed
- Checks if the database connection is ok.
- getPdo() : PDO
- Returns the PDO to read and write data.
- useRemoteDb() : bool
- Returns if a remote database is to be used.
- createInitialSchema() : void
- Creates the initial schema.
- getPdoUrl() : string
- Builds the PDO URL.
- updateSchema() : mixed
- Updates the schema to latest version.
Constants
TABLE_MAIN_CONFIG
table for main configuration
public
mixed
TABLE_MAIN_CONFIG
= 'main_configuration'
TABLE_SCHEMA_VERSIONS
table for schema versions
public
mixed
TABLE_SCHEMA_VERSIONS
= 'schema_versions'
ROW_VERSION_MAIN_CONFIG
row name for main config schema version
private
mixed
ROW_VERSION_MAIN_CONFIG
= 'main_configuration'
ROW_VERSION_SYSTEM
row name for system schema version
private
mixed
ROW_VERSION_SYSTEM
= 'system'
Properties
$cfgMain
private
mixed
$cfgMain
$pdo
private
PDO
$pdo
PDO
Methods
__construct()
Constructor
public
__construct(LAMCfgMain $cfgMain) : mixed
Parameters
- $cfgMain : LAMCfgMain
-
main configuration
Return values
mixed —checkConnection()
Checks if the database connection is ok.
public
checkConnection() : mixed
Tags
Return values
mixed —getPdo()
Returns the PDO to read and write data.
public
getPdo() : PDO
Tags
Return values
PDO —PDO
useRemoteDb()
Returns if a remote database is to be used.
public
useRemoteDb() : bool
Return values
bool —use remote database
createInitialSchema()
Creates the initial schema.
private
createInitialSchema(PDO $pdo) : void
Parameters
- $pdo : PDO
-
PDO
Return values
void —getPdoUrl()
Builds the PDO URL.
private
getPdoUrl() : string
Return values
string —PDO URL
updateSchema()
Updates the schema to latest version.
private
updateSchema(PDO $pdo) : mixed
Parameters
- $pdo : PDO
-
PDO