Référence de la classe DatabaseHelper

Fonctions membres publiques statiques
static	getDbo ($driver, $host, $user, $password, $database, $prefix, $select=true, array $ssl=[])
static	getEncryptionSettings ($options)
static	getMinimumServerVersion ($db, $options)
static	validateConnectionParameters ($options)
static	checkRemoteDbHost ($options)
static	checkDbServerParameters ($db, $options)

Attributs protégés statiques
static	$dbMinimumMariaDb = '10.1'
static	$dbMinimumMySql = '5.6'
static	$dbMinimumPostgreSql = '11.0'

Description détaillée

Joomla Installation Database Helper Class.

Depuis

1.6

Documentation des fonctions membres

checkDbServerParameters()

static checkDbServerParameters (   $db,   $options  )

static

Check database server parameters after connection

Paramètres

DatabaseDriver	$db	Database object
\stdClass	$options	The session options

Renvoie

string|boolean A string with the translated error message if some server parameter is not ok, otherwise false.

Depuis

4.0.0

Références $db, $options, Text\_(), et Text\sprintf().

Référencé par DatabaseModel\createDatabase(), et SetupModel\validateDbConnection().

checkRemoteDbHost()

static checkRemoteDbHost (   $options )

static

Security check for remote db hosts

Paramètres

\stdClass

$options

The session options

Renvoie

boolean True if passed, otherwise false.

Depuis

4.0.0

Références $options, Text\_(), File\exists(), UserHelper\genRandomPassword(), Factory\getApplication(), Factory\getSession(), JPATH_INSTALLATION, Text\sprintf(), et File\write().

Référencé par DatabaseModel\initialise(), et SetupModel\validateDbConnection().

getDbo()

static getDbo (   $driver,   $host,   $user,   $password,   $database,   $prefix,   $select = true, array  $ssl = []  )

static

Method to get a database driver.

Paramètres

string	$driver	The database driver to use.
string	$host	The hostname to connect on.
string	$user	The user name to connect with.
string	$password	The password to use for connection authentication.
string	$database	The database to use.
string	$prefix	The table prefix to use.
boolean	$select	True if the database should be selected.
array	$ssl	Database TLS connection options.

Renvoie

DatabaseInterface

Depuis

1.6

Références $db, $options, $password, $prefix, $user, $value, et DatabaseDriver\getInstance().

Référencé par DatabaseModel\initialise(), ConfigurationModel\setup(), et SetupModel\validateDbConnection().

getEncryptionSettings()

static getEncryptionSettings (   $options )

static

Convert encryption options to array.

Paramètres

\stdClass

$options

The session options

Renvoie

array The encryption settings

Depuis

4.0.0

Références $options.

Référencé par DatabaseModel\createDatabase(), DatabaseModel\initialise(), ConfigurationModel\setup(), et SetupModel\validateDbConnection().

getMinimumServerVersion()

static getMinimumServerVersion (   $db,   $options  )

static

Get the minimum required database server version.

Paramètres

DatabaseDriver	$db	Database object
\stdClass	$options	The session options

Renvoie

string The minimum required database server version.

Depuis

4.0.0

Références $db, et $options.

validateConnectionParameters()

static validateConnectionParameters (   $options )

static

Validate and clean up database connection parameters.

Paramètres

\stdClass

$options

The session options

Renvoie

string|boolean A string with the translated error message if validation error, otherwise false.

Depuis

4.0.0

Références $options, Text\_(), Path\clean(), File\exists(), ArrayHelper\fromObject(), Factory\getSession(), et Text\sprintf().

Référencé par DatabaseModel\initialise(), et SetupModel\validateDbConnection().

Documentation des champs

$dbMinimumMariaDb

$dbMinimumMariaDb = '10.1'

staticprotected

$dbMinimumMySql

$dbMinimumMySql = '5.6'

staticprotected

$dbMinimumPostgreSql

$dbMinimumPostgreSql = '11.0'

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• DatabaseHelper.php