Référence de la classe JDatabase

Graphe d'héritage de JDatabase:

Fonctions membres publiques
	query ()
	getErrorMsg ($escaped=false)
	getErrorNum ()
	stderr ($showSQL=false)

Fonctions membres publiques statiques
static	getConnectors ()
static	getInstance ($options=array())
static	splitSql ($query)
static	test ()

Description détaillée

Database connector class.

Depuis

1.7.0

Obsolète:

4.0

Documentation des fonctions membres

getConnectors()

static getConnectors ( )

static

Get a list of available database connectors. The list will only be populated with connectors that both the class exists and the static test method returns true. This gives us the ability to have a multitude of connector classes that are self-aware as to whether or not they are able to be used on a given system.

Renvoie

array An array of available database connectors.

Depuis

1.7.0

Obsolète:

4.0

Références JDatabaseDriver\getConnectors().

getErrorMsg()

getErrorMsg

(

$escaped = false

)

Gets the error message from the database connection.

Paramètres

boolean

$escaped

True to escape the message string for use in JavaScript.

Renvoie

string The error message for the most recent query.

Obsolète:

4.0

Depuis

1.7.0

getErrorNum()

getErrorNum

(

)

Gets the error number from the database connection.

Renvoie

integer The error number for the most recent query.

Depuis

1.7.0

Obsolète:

4.0

getInstance()

static getInstance (   $options = array() )

static

Method to return a JDatabaseDriver instance based on the given options. There are three global options and then the rest are specific to the database driver. The 'driver' option defines which JDatabaseDriver class is used for the connection – the default is 'mysqli'. The 'database' option determines which database is to be used for the connection. The 'select' option determines whether the connector should automatically select the chosen database.

Instances are unique to the given options and new objects are only created when a unique options array is passed into the method. This ensures that we don't end up with unnecessary database connection resources.

Paramètres

array

$options

Parameters to be passed to the database driver.

Renvoie

JDatabaseDriver A database object.

Depuis

1.7.0

Obsolète:

4.0

Références $options, et JDatabaseDriver\getInstance().

query()

query

(

)

Execute the SQL statement.

Renvoie

mixed A database cursor resource on success, boolean false on failure.

Depuis

1.7.0

Exceptions

RuntimeException

Obsolète:

4.0

splitSql()

static splitSql (   $query )

static

Splits a string of multiple queries into an array of individual queries.

Paramètres

string

$query

Input SQL string with which to split into individual queries.

Renvoie

array The queries from the input string separated into an array.

Depuis

1.7.0

Obsolète:

4.0

Références $query, et JDatabaseDriver\splitSql().

stderr()

stderr

(

$showSQL = false

)

Return the most recent error message for the database connector.

Paramètres

boolean

$showSQL

True to display the SQL statement sent to the database as well as the error.

Renvoie

string The error message for the most recent query.

Depuis

1.7.0

Obsolète:

4.0

test()

static test ( )

static

Test to see if the connector is available.

Renvoie

boolean True on success, false otherwise.

Depuis

1.7.0

Obsolète:

4.0 - Use JDatabaseDriver::isSupported() instead.

---

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

• libraries/joomla/database/database.php