Référence de la classe JDatabaseMySQL

Graphe d'héritage de JDatabaseMySQL:

Graphe de collaboration de JDatabaseMySQL:

Liste de tous les membres

Fonctions membres publiques
	__destruct ()
	escape ($text, $extra=false)
	connected ()
	dropTable ($tableName, $ifExists=true)
	getAffectedRows ()
	getCollation ()
	getExporter ()
	getImporter ()
	getNumRows ($cursor=null)
	getQuery ($new=false)
	getTableCreate ($tables)
	getTableColumns ($table, $typeOnly=true)
	getTableKeys ($table)
	getTableList ()
	getVersion ()
	hasUTF ()
	insertid ()
	lockTable ($table)
	execute ()
	renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
	select ($database)
	setUTF ()
	transactionCommit ()
	transactionRollback ()
	transactionStart ()
	explain ()
	queryBatch ($abortOnError=true, $transactionSafe=false)
	unlockTables ()
Fonctions membres publiques inherited from JDatabase
	__call ($method, $args)
	addQuoted ($quoted)
	getConnection ()
	getCount ()
	getDateFormat ()
	getLimit ()
	getLog ()
	getMinimum ()
	getNullDate ()
	getOffset ()
	getPrefix ()
	getUTFSupport ()
	insertObject ($table, &$object, $key=null)
	isMinimumVersion ()
	loadAssoc ()
	loadAssocList ($key=null, $column=null)
	loadColumn ($offset=0)
	loadNextObject ($class= 'stdClass')
	loadNextRow ()
	loadObject ($class= 'stdClass')
	loadObjectList ($key= '', $class= 'stdClass')
	loadResult ()
	loadRow ()
	loadRowList ($key=null)
	query ()
	quote ($text, $escape=true)
	quoteName ($name, $as=null)
	replacePrefix ($sql, $prefix= '#__')
	setDebug ($level)
	setQuery ($query, $offset=0, $limit=0)
	truncateTable ($table)
	updateObject ($table, &$object, $key, $nulls=false)
	debug ($level)
	getErrorMsg ($escaped=false)
	getErrorNum ()
	getEscaped ($text, $extra=false)
	getTableFields ($tables, $typeOnly=true)
	getTicker ()
	isQuoted ($field)
	loadResultArray ($offset=0)
	nameQuote ($name)
	stderr ($showSQL=false)

Fonctions membres publiques statiques
static	test ()
Fonctions membres publiques statiques inherited from JDatabase
static	getConnectors ()
static	getInstance ($options=array())
static	splitSql ($sql)

Attributs publics
	$name = 'mysql'
Attributs publics inherited from JDatabase

Fonctions membres protégées
	__construct ($options)
	fetchArray ($cursor=null)
	fetchAssoc ($cursor=null)
	fetchObject ($cursor=null, $class= 'stdClass')
	freeResult ($cursor=null)
Fonctions membres protégées inherited from JDatabase
	getDatabase ()
	quoteNameStr ($strArr)

Attributs protégés
	$nameQuote = '`'
	$nullDate = '0000-00-00 00:00:00'
	$dbMinimum = '5.0.4'
Attributs protégés inherited from JDatabase
	$connection
	$count = 0
	$cursor
	$debug = false
	$limit = 0
	$log = array()
	$offset = 0
	$sql
	$tablePrefix
	$utf = true
	$errorNum = 0
	$errorMsg
	$hasQuoted = false
	$quoted = array()

Additional Inherited Members
Attributs protégés statiques inherited from JDatabase
static	$instances = array()

---

Documentation des constructeurs et destructeur

JDatabaseMySQL::__construct (   $options )

protected

Constructor.

Paramètres:

array

$options

Array of database options with keys: host, user, password, database, select.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références JError\$legacy, $options, et JText\_().

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::__destruct

(

)

Destructor.

Depuis:

11.1

Réimplémentée dans JDatabaseMySQLi.

---

Documentation des fonctions membres

JDatabaseMySQL::connected

(

)

Determines if the connection to the server is active.

Renvoie:

boolean True if connected to the database engine.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::dropTable	(		$tableName,
			$ifExists = true
	)

Drops a table from the database.

Paramètres:

string	$tableName	The name of the database table to drop.
boolean	$ifExists	Optionally specify that the table must exist before it is dropped.

Renvoie:

JDatabaseMySQL Returns this object to support chaining.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

Références $query.

JDatabaseMySQL::escape	(		$text,
			$extra = false
	)

Method to escape a string for usage in an SQL statement.

Paramètres:

string	$text	The string to be escaped.
boolean	$extra	Optional parameter to provide extra escaping.

Renvoie:

string The escaped string.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références $text.

JDatabaseMySQL::execute

(

)

Execute the SQL statement.

Renvoie:

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

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références JError\$legacy, $limit, JLog\add(), JLog\DEBUG, JLog\ERROR, JError\raiseError(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::explain

(

)

Diagnostic method to return explain information for a query.

Renvoie:

string The explain output.

Depuis:

11.1

Obsolète:

12.1

Réimplémentée à partir de JDatabase.

Références $row, JLog\add(), null, et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::fetchArray (   $cursor = null )

protected

Method to fetch a row from the result set cursor as an array.

Paramètres:

mixed

$cursor

The optional result set cursor from which to fetch the row.

Renvoie:

mixed Either the next row from the result set or false if there are no more rows.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::fetchAssoc (   $cursor = null )

protected

Method to fetch a row from the result set cursor as an associative array.

Paramètres:

mixed

$cursor

The optional result set cursor from which to fetch the row.

Renvoie:

mixed Either the next row from the result set or false if there are no more rows.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::fetchObject (   $cursor = null,   $class = 'stdClass'  )

protected

Method to fetch a row from the result set cursor as an object.

Paramètres:

mixed	$cursor	The optional result set cursor from which to fetch the row.
string	$class	The class name to use for the returned row object.

Renvoie:

mixed Either the next row from the result set or false if there are no more rows.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références $class.

JDatabaseMySQL::freeResult (   $cursor = null )

protected

Method to free up the memory used for the result set.

Paramètres:

mixed

$cursor

The optional result set cursor from which to fetch the row.

Renvoie:

void

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::getAffectedRows

(

)

Get the number of affected rows for the previous executed SQL statement.

Renvoie:

integer The number of affected rows.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::getCollation

(

)

Method to get the database collation in use by sampling a text field of a table in the database.

Renvoie:

mixed The collation in use by the database (string) or boolean false if not supported.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::getExporter

(

)

Gets an exporter class object.

Renvoie:

JDatabaseExporterMySQL An exporter object.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée dans JDatabaseMySQLi.

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::getImporter

(

)

Gets an importer class object.

Renvoie:

JDatabaseImporterMySQL An importer object.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée dans JDatabaseMySQLi.

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::getNumRows

(

$cursor = null

)

Get the number of returned rows for the previous executed SQL statement.

Paramètres:

resource

$cursor

An optional database cursor resource to extract the row count from.

Renvoie:

integer The number of returned rows.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::getQuery

(

$new = false

)

Get the current or query, or new JDatabaseQuery object.

Paramètres:

boolean

$new

False to return the last query set, True to return a new JDatabaseQuery object.

Renvoie:

mixed The current value of the internal SQL variable or a new JDatabaseQuery object.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références JText\_().

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::getTableColumns	(		$table,
			$typeOnly = true
	)

Retrieves field information about a given table.

Paramètres:

string	$table	The name of the database table.
boolean	$typeOnly	True to only return field types.

Renvoie:

array An array of fields for the database table.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

Références $field, et $fields.

JDatabaseMySQL::getTableCreate

(

$tables

)

Shows the table CREATE statement that creates the given tables.

Paramètres:

mixed

$tables

A table name or a list of table names.

Renvoie:

array A list of the create SQL for the tables.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

Références $row.

JDatabaseMySQL::getTableKeys

(

$table

)

Get the details list of keys for a table.

Paramètres:

string

$table

The name of the table.

Renvoie:

array An array of the column specification for the table.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::getTableList

(

)

Method to get an array of all tables in the database.

Renvoie:

array An array of all the tables in the database.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::getVersion

(

)

Get the version of the database connector.

Renvoie:

string The database connector version.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::hasUTF

(

)

Determines if the database engine supports UTF-8 character encoding.

Renvoie:

boolean True if supported.

Depuis:

11.1

Obsolète:

12.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::insertid

(

)

Method to get the auto-incremented value from the last INSERT statement.

Renvoie:

integer The value of the auto-increment field from the last inserted row.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::lockTable

(

$table

)

Locks a table in the database.

Paramètres:

string

$table

The name of the table to unlock.

Renvoie:

JDatabaseMySQL Returns this object to support chaining.

Depuis:

11.4

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::queryBatch	(		$abortOnError = true,
			$transactionSafe = false
	)

Execute a query batch.

Paramètres:

boolean	$abortOnError	Abort on error.
boolean	$transactionSafe	Transaction safe queries.

Renvoie:

mixed A database resource if successful, false if not.

Obsolète:

12.1

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références $query, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::renameTable	(		$oldTable,
			$newTable,
			$backup = null,
			$prefix = null
	)

Renames a table in the database.

Paramètres:

string	$oldTable	The name of the table to be renamed
string	$newTable	The new name for the table.
string	$backup	Not used by MySQL.
string	$prefix	Not used by MySQL.

Renvoie:

JDatabase Returns this object to support chaining.

Depuis:

11.4

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::select

(

$database

)

Select a database for use.

Paramètres:

string

$database

The name of the database to select for use.

Renvoie:

boolean True if the database was successfully selected.

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

Références JError\$legacy, et JText\_().

Voici le graphe d'appel pour cette fonction :

JDatabaseMySQL::setUTF

(

)

Set the connection to use UTF-8 character encoding.

Renvoie:

boolean True on success.

Depuis:

11.1

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

static JDatabaseMySQL::test ( )

static

Test to see if the MySQL connector is available.

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Implémente JDatabaseInterface.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::transactionCommit

(

)

Method to commit a transaction.

Renvoie:

void

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::transactionRollback

(

)

Method to roll back a transaction.

Renvoie:

void

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::transactionStart

(

)

Method to initialize a transaction.

Renvoie:

void

Depuis:

11.1

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::unlockTables

(

)

Unlocks tables in the database.

Renvoie:

JDatabaseMySQL Returns this object to support chaining.

Depuis:

11.4

Exceptions:

JDatabaseException

Réimplémentée à partir de JDatabase.

---

Documentation des données membres

JDatabaseMySQL::$dbMinimum = '5.0.4'

protected

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::$name = 'mysql'

Réimplémentée à partir de JDatabase.

Réimplémentée dans JDatabaseMySQLi.

JDatabaseMySQL::$nameQuote = '`'

protected

Réimplémentée à partir de JDatabase.

JDatabaseMySQL::$nullDate = '0000-00-00 00:00:00'

protected

Réimplémentée à partir de JDatabase.

---

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

• libraries/joomla/database/database/mysql.php