DatabaseConfigurationHelper

interface DatabaseConfigurationHelper (View source)

Interface for database helper classes.

Methods

public
bool
requireDatabaseFunctions(array $databaseConfig)

Ensure that the database function for connectivity is available.

public
array
requireDatabaseServer(array $databaseConfig)

Ensure that the database server exists.

public
array
requireDatabaseConnection(array $databaseConfig)

Ensure a database connection is possible using credentials provided.

public
string
getDatabaseVersion(array $databaseConfig)

Determines the version of the database server

public
array
requireDatabaseVersion(array $databaseConfig)

Check database version is greater than the minimum supported

public
array
requireDatabaseOrCreatePermissions(array $databaseConfig)

Ensure that the database connection is able to use an existing database, or be able to create one if it doesn't exist.

public
array
requireDatabaseAlterPermissions(array $databaseConfig)

Ensure we have permissions to alter tables.

Details

at line 17
bool requireDatabaseFunctions(array $databaseConfig)

Ensure that the database function for connectivity is available.

If it is, we assume the PHP module for this database has been setup correctly.

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

bool

at line 25
array requireDatabaseServer(array $databaseConfig)

Ensure that the database server exists.

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

array

Result - e.g. array('okay' => true, 'error' => 'details of error')

at line 34
array requireDatabaseConnection(array $databaseConfig)

Ensure a database connection is possible using credentials provided.

The established connection resource is returned with the results as well.

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

array

Result - e.g. array('okay' => true, 'connection' => mysql link, 'error' => 'details of error')

at line 42
string getDatabaseVersion(array $databaseConfig)

Determines the version of the database server

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

string

Version of database server or false on failure

at line 50
array requireDatabaseVersion(array $databaseConfig)

Check database version is greater than the minimum supported

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

array

Result - e.g. array('success' => true, 'error' => 'details of error')

at line 59
array requireDatabaseOrCreatePermissions(array $databaseConfig)

Ensure that the database connection is able to use an existing database, or be able to create one if it doesn't exist.

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

array

Result - e.g. array('okay' => true, 'existsAlready' => 'true')

at line 69
array requireDatabaseAlterPermissions(array $databaseConfig)

Ensure we have permissions to alter tables.

Parameters

array $databaseConfig

Associative array of db configuration, e.g. "server", "username" etc

Return Value

array

Result - e.g. array('okay' => true, 'applies' => true), where applies is whether the test is relevant for the database