Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JDatabase
+ Graphe d'héritage de JDatabase:
+ Graphe de collaboration de JDatabase:

Liste de tous les membres

Fonctions membres publiques

 __call ($method, $args)
 addQuoted ($quoted)
 connected ()
 dropTable ($table, $ifExists=true)
 escape ($text, $extra=false)
 getAffectedRows ()
 getCollation ()
 getConnection ()
 getCount ()
 getDateFormat ()
 getLimit ()
 getLog ()
 getMinimum ()
 getNullDate ()
 getNumRows ($cursor=null)
 getOffset ()
 getPrefix ()
 getQuery ($new=false)
 getTableColumns ($table, $typeOnly=true)
 getTableCreate ($tables)
 getTableKeys ($tables)
 getTableList ()
 getUTFSupport ()
 getVersion ()
 hasUTF ()
 insertid ()
 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)
 lockTable ($tableName)
 query ()
 execute ()
 quote ($text, $escape=true)
 quoteName ($name, $as=null)
 replacePrefix ($sql, $prefix= '#__')
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 select ($database)
 setDebug ($level)
 setQuery ($query, $offset=0, $limit=0)
 setUTF ()
 transactionCommit ()
 transactionRollback ()
 transactionStart ()
 truncateTable ($table)
 updateObject ($table, &$object, $key, $nulls=false)
 unlockTables ()
 debug ($level)
 explain ()
 getErrorMsg ($escaped=false)
 getErrorNum ()
 getEscaped ($text, $extra=false)
 getTableFields ($tables, $typeOnly=true)
 getTicker ()
 isQuoted ($field)
 loadResultArray ($offset=0)
 nameQuote ($name)
 queryBatch ($abortOnError=true, $transactionSafe=false)
 stderr ($showSQL=false)

Fonctions membres publiques statiques

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

Attributs publics

 $name

Fonctions membres protégées

 __construct ($options)
 fetchArray ($cursor=null)
 fetchAssoc ($cursor=null)
 fetchObject ($cursor=null, $class= 'stdClass')
 freeResult ($cursor=null)
 getDatabase ()
 quoteNameStr ($strArr)

Attributs protégés

 $connection
 $count = 0
 $cursor
 $debug = false
 $limit = 0
 $log = array()
 $nameQuote
 $nullDate
 $offset = 0
 $sql
 $tablePrefix
 $utf = true
 $errorNum = 0
 $errorMsg
 $hasQuoted = false
 $quoted = array()
 $dbMinimum

Attributs protégés statiques

static $instances = array()

Attributs privés

 $_database

Documentation des constructeurs et destructeur

JDatabase::__construct (   $options)
protected

Constructor.

Paramètres:
array$optionsList of options used to configure the connection
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Références $options, et setUTF().

Référencé par JDatabaseMySQLi\__construct().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :


Documentation des fonctions membres

JDatabase::__call (   $method,
  $args 
)

Magic method to provide method alias support for quote() and quoteName().

Paramètres:
string$methodThe called method.
array$argsThe array of arguments passed to the method.
Renvoie:
string The aliased method's return value or null.
Depuis:
11.1

Références null, quote(), et quoteName().

+ Voici le graphe d'appel pour cette fonction :

JDatabase::addQuoted (   $quoted)

Adds a field or array of field names to the list that are to be quoted.

Paramètres:
mixed$quotedField name or array of names.
Renvoie:
void
Obsolète:
12.1
Depuis:
11.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::connected ( )
abstract

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 dans JDatabaseSQLSrv, JDatabaseMySQLi, et JDatabaseMySQL.

JDatabase::debug (   $level)

Sets the debug level on or off

Paramètres:
integer$level0 to disable debugging and 1 to enable it.
Renvoie:
void
Obsolète:
12.1
Depuis:
11.1

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

Référencé par setDebug().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::dropTable (   $table,
  $ifExists = true 
)
abstract

Drops a table from the database.

Paramètres:
string$tableThe name of the database table to drop.
boolean$ifExistsOptionally specify that the table must exist before it is dropped.
Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::escape (   $text,
  $extra = false 
)
abstract

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

Paramètres:
string$textThe string to be escaped.
boolean$extraOptional parameter to provide extra escaping.
Renvoie:
string The escaped string.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQLi, et JDatabaseMySQL.

Référencé par getEscaped(), et quote().

+ Voici le graphe des appelants de cette fonction :

mixed The current SQL statement to JDatabase::execute ( )
abstract

Execute the SQL statement.

Renvoie:
mixed A database cursor resource on success, boolean false on failure.
Depuis:
12.1
Exceptions:
JDatabaseException
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par insertObject(), loadAssoc(), loadAssocList(), loadColumn(), loadNextObject(), loadNextRow(), loadObject(), loadObjectList(), loadResult(), loadRow(), loadRowList(), query(), truncateTable(), et updateObject().

+ Voici le graphe des appelants de cette fonction :

JDatabase::explain ( )
abstract

Diagnostic method to return explain information for a query.

Renvoie:
string The explain output.
Obsolète:
12.1
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::fetchArray (   $cursor = null)
abstractprotected

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

Paramètres:
mixed$cursorThe 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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par loadColumn(), loadNextRow(), loadResult(), loadRow(), et loadRowList().

+ Voici le graphe des appelants de cette fonction :

JDatabase::fetchAssoc (   $cursor = null)
abstractprotected

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

Paramètres:
mixed$cursorThe 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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par loadAssoc(), et loadAssocList().

+ Voici le graphe des appelants de cette fonction :

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

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

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
string$classThe 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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par loadNextObject(), loadObject(), et loadObjectList().

+ Voici le graphe des appelants de cette fonction :

JDatabase::freeResult (   $cursor = null)
abstractprotected

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

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
void
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par loadAssoc(), loadAssocList(), loadColumn(), loadNextObject(), loadNextRow(), loadObject(), loadObjectList(), loadResult(), loadRow(), et loadRowList().

+ Voici le graphe des appelants de cette fonction :

JDatabase::getAffectedRows ( )
abstract

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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::getCollation ( )
abstract

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 or boolean false if not supported.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::getConnection ( )

Method that provides access to the underlying database connection. Useful for when you need to call a proprietary method such as postgresql's lo_* methods.

Renvoie:
resource The underlying database connection resource.
Depuis:
11.1

Références $connection.

static JDatabase::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:
11.1

Références $class, $path, $type, JFolder\files(), et JLoader\register().

Référencé par JFormFieldDatabaseConnection\getOptions(), et JInstallationModelSetup\getPhpOptions().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::getCount ( )

Get the total number of SQL statements executed by the database driver.

Renvoie:
integer
Depuis:
11.1

Références $count.

JDatabase::getDatabase ( )
protected

Gets the name of the database used by this conneciton.

Renvoie:
string
Depuis:
11.4

Références $_database.

JDatabase::getDateFormat ( )

Returns a PHP date() function compliant date format for the database driver.

Renvoie:
string The format string.
Depuis:
11.1
JDatabase::getErrorMsg (   $escaped = false)

Gets the error message from the database connection.

Paramètres:
boolean$escapedTrue to escape the message string for use in JavaScript.
Renvoie:
string The error message for the most recent query.
Obsolète:
12.1
Depuis:
11.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::getErrorNum ( )

Gets the error number from the database connection.

Renvoie:
integer The error number for the most recent query.
Depuis:
11.1
Obsolète:
12.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::getEscaped (   $text,
  $extra = false 
)

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

Paramètres:
string$textThe string to be escaped.
boolean$extraOptional parameter to provide extra escaping.
Renvoie:
string The escaped string.
Depuis:
11.1
Obsolète:
12.1

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

+ Voici le graphe d'appel pour cette fonction :

static JDatabase::getInstance (   $options = array())
static

Method to return a JDatabase 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 'mysql'. 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$optionsParameters to be passed to the database driver.
Renvoie:
JDatabase A database object.
Depuis:
11.1

Références $class, JError\$legacy, $options, $path, JLog\add(), null, JError\raiseError(), JLoader\register(), JError\setErrorHandling(), JText\sprintf(), et JLog\WARNING.

Référencé par JLoggerDatabase\connect(), JFactory\createDbo(), et JInstallationHelperDatabase\getDBO().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::getLimit ( )

Get the row limit for the current SQL statement.

Renvoie:
integer The affected row limit for the current SQL statement.
Depuis:
2.5.17 (CMS Only)
Obsolète:
3.0 Required for SQLSRV support for 2.5 only

Références $limit.

JDatabase::getLog ( )

Get the database driver SQL statement log.

Renvoie:
array SQL statements executed by the database driver.
Depuis:
11.1

Références $log.

JDatabase::getMinimum ( )

Get the minimum supported database version.

Renvoie:
string The minimum version number for the database driver.
Depuis:
12.1

Références $dbMinimum.

JDatabase::getNullDate ( )

Get the null or zero representation of a timestamp for the database driver.

Renvoie:
string Null or zero representation of a timestamp.
Depuis:
11.1

Références $nullDate.

JDatabase::getNumRows (   $cursor = null)
abstract

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

Paramètres:
resource$cursorAn optional database cursor resource to extract the row count from.
Renvoie:
integer The number of returned rows.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::getOffset ( )

Get the row offset for the current SQL statement.

Renvoie:
integer The affected row offset to apply for the current SQL statement.
Depuis:
2.5.17 (CMS Only)
Obsolète:
3.0 Required for SQLSRV support for 2.5 only

Références $offset.

JDatabase::getPrefix ( )

Get the common table prefix for the database driver.

Renvoie:
string The common database table prefix.
Depuis:
11.1

Références $tablePrefix.

JDatabase::getQuery (   $new = false)
abstract

Get the current query object or a new JDatabaseQuery object.

Paramètres:
boolean$newFalse to return the current query object, True to return a new JDatabaseQuery object.
Renvoie:
JDatabaseQuery The current query object or a new object extending the JDatabaseQuery class.
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, JDatabaseMySQLi, et JDatabaseSQLAzure.

JDatabase::getTableColumns (   $table,
  $typeOnly = true 
)
abstract

Retrieves field information about the given tables.

Paramètres:
string$tableThe name of the database table.
boolean$typeOnlyTrue (default) to only return field types.
Renvoie:
array An array of fields by table.
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

Référencé par getTableFields().

+ Voici le graphe des appelants de cette fonction :

JDatabase::getTableCreate (   $tables)
abstract

Shows the table CREATE statement that creates the given tables.

Paramètres:
mixed$tablesA 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 dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::getTableFields (   $tables,
  $typeOnly = true 
)

Retrieves field information about the given tables.

Paramètres:
mixed$tablesA table name or a list of table names.
boolean$typeOnlyTrue to only return field types.
Renvoie:
array An array of fields by table.
Depuis:
11.1
Exceptions:
JDatabaseException
Obsolète:
12.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::getTableKeys (   $tables)
abstract

Retrieves field information about the given tables.

Paramètres:
mixed$tablesA table name or a list of table names.
Renvoie:
array An array of keys for the table(s).
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::getTableList ( )
abstract

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 dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::getTicker ( )

Get the total number of SQL statements executed by the database driver.

Renvoie:
integer
Depuis:
11.1
Obsolète:
12.1

Références $count, JLog\add(), et JLog\NOTICE.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::getUTFSupport ( )

Determine whether or not the database engine supports UTF-8 character encoding.

Renvoie:
boolean True if the database engine supports UTF-8 character encoding.
Depuis:
11.1

Références $utf.

JDatabase::getVersion ( )
abstract

Get the version of the database connector

Renvoie:
string The database connector version.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par isMinimumVersion().

+ Voici le graphe des appelants de cette fonction :

JDatabase::hasUTF ( )
abstract

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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::insertid ( )
abstract

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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par insertObject().

+ Voici le graphe des appelants de cette fonction :

JDatabase::insertObject (   $table,
$object,
  $key = null 
)

Inserts a row into a table based on an object's properties.

Paramètres:
string$tableThe name of the database table to insert into.
object&$objectA reference to an object whose public properties match the table fields.
string$keyThe name of the primary key. If provided the object property is updated.
Renvoie:
boolean True on success.
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv.

Références $fields, $id, $key, execute(), insertid(), null, quote(), quoteName(), et setQuery().

+ Voici le graphe d'appel pour cette fonction :

JDatabase::isMinimumVersion ( )

Method to check whether the installed database version is supported by the database driver

Renvoie:
boolean True if the database version is supported
Depuis:
12.1

Références getVersion().

+ Voici le graphe d'appel pour cette fonction :

JDatabase::isQuoted (   $field)

Checks if field name needs to be quoted.

Paramètres:
string$fieldThe field name to be checked.
Renvoie:
bool
Obsolète:
12.1
Depuis:
11.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadAssoc ( )

Method to get the first row of the result set from the database query as an associative array of ['field_name' => 'row_value'].

Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $cursor, execute(), fetchAssoc(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadAssocList (   $key = null,
  $column = null 
)

Method to get an array of the result set rows from the database query where each row is an associative array of ['field_name' => 'row_value']. The array of rows can optionally be keyed by a field name, but defaults to a sequential numeric array.

NOTE: Chosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.

Paramètres:
string$keyThe name of a field on which to key the result array.
string$columnAn optional column name. Instead of the whole row, only this column value will be in the result array.
Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $cursor, $key, $row, execute(), fetchAssoc(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadColumn (   $offset = 0)

Method to get an array of values from the $offset field in each row of the result set from the database query.

Paramètres:
integer$offsetThe row offset to use to build the result array.
Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $cursor, $offset, $row, execute(), fetchArray(), freeResult(), et null.

Référencé par loadResultArray().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::loadNextObject (   $class = 'stdClass')

Method to get the next row in the result set from the database query as an object.

Paramètres:
string$classThe class name to use for the returned row object.
Renvoie:
mixed The result of the query as an array, false if there are no more rows.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $class, $cursor, $row, execute(), fetchObject(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadNextRow ( )

Method to get the next row in the result set from the database query as an array.

Renvoie:
mixed The result of the query as an array, false if there are no more rows.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $cursor, $row, execute(), fetchArray(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadObject (   $class = 'stdClass')

Method to get the first row of the result set from the database query as an object.

Paramètres:
string$classThe class name to use for the returned row object.
Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $class, $cursor, execute(), fetchObject(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadObjectList (   $key = '',
  $class = 'stdClass' 
)

Method to get an array of the result set rows from the database query where each row is an object. The array of objects can optionally be keyed by a field name, but defaults to a sequential numeric array.

NOTE: Choosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.

Paramètres:
string$keyThe name of a field on which to key the result array.
string$classThe class name to use for the returned row objects.
Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $class, $cursor, $key, $row, execute(), fetchObject(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadResult ( )

Method to get the first field of the first row of the result set from the database query.

Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv.

Références $cursor, $row, execute(), fetchArray(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadResultArray (   $offset = 0)

Method to get an array of values from the $offset field in each row of the result set from the database query.

Paramètres:
integer$offsetThe row offset to use to build the result array.
Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException
Obsolète:
12.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadRow ( )

Method to get the first row of the result set from the database query as an array. Columns are indexed numerically so the first column in the result set would be accessible via $row[0], etc.

Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $cursor, $row, execute(), fetchArray(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::loadRowList (   $key = null)

Method to get an array of the result set rows from the database query where each row is an array. The array of objects can optionally be keyed by a field offset, but defaults to a sequential numeric array.

NOTE: Choosing to key the result array by a non-unique field can result in unwanted behavior and should be avoided.

Paramètres:
string$keyThe name of a field on which to key the result array.
Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $cursor, $key, $row, execute(), fetchArray(), freeResult(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabase::lockTable (   $tableName)
abstract

Locks a table in the database.

Paramètres:
string$tableNameThe name of the table to unlock.
Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::nameQuote (   $name)

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

Paramètres:
string$nameThe identifier name to wrap in quotes.
Renvoie:
string The quote wrapped name.
Depuis:
11.1
Obsolète:
12.1

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

+ Voici le graphe d'appel pour cette fonction :

boolean If true then there are fields to be quoted for the JDatabase::query ( )

Execute the SQL statement.

Renvoie:
mixed A database cursor resource on success, boolean false on failure.
Depuis:
11.1
Exceptions:
JDatabaseException
Depuis:
11.1
11.1
Obsolète:
12.1

Références execute().

+ Voici le graphe d'appel pour cette fonction :

JDatabase::queryBatch (   $abortOnError = true,
  $transactionSafe = false 
)
abstract

Execute a query batch.

Paramètres:
boolean$abortOnErrorAbort on error.
boolean$transactionSafeTransaction safe queries.
Renvoie:
mixed A database resource if successful, false if not.
Obsolète:
12.1
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::quote (   $text,
  $escape = true 
)

Method to quote and optionally escape a string to database requirements for insertion into the database.

Paramètres:
string$textThe string to quote.
boolean$escapeTrue (default) to escape the string, false to leave it unchanged.
Renvoie:
string The quoted input string.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv.

Références $text, et escape().

Référencé par __call(), insertObject(), et updateObject().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::quoteName (   $name,
  $as = null 
)

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

Paramètres:
mixed$nameThe identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.
mixed$asThe AS query part associated to $name. It can be string or array, in latter case it has to be same length of $name; if is null there will not be any AS part for string or array element.
Renvoie:
mixed The quote wrapped name, same type of $name.
Depuis:
11.1

Références $i, $name, elseif, et quoteNameStr().

Référencé par __call(), insertObject(), nameQuote(), truncateTable(), et updateObject().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::quoteNameStr (   $strArr)
protected

Quote strings coming from quoteName call.

Paramètres:
array$strArrArray of strings coming from quoteName dot-explosion.
Renvoie:
string Dot-imploded string of quoted parts.
Depuis:
11.3

Références $nameQuote, et $parts.

Référencé par quoteName().

+ Voici le graphe des appelants de cette fonction :

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

Renames a table in the database.

Paramètres:
string$oldTableThe name of the table to be renamed
string$newTableThe new name for the table.
string$backupTable prefix
string$prefixFor the table - used to rename constraints in non-mysql databases
Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::replacePrefix (   $sql,
  $prefix = '#__' 
)

This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.

Paramètres:
string$sqlThe SQL statement to prepare.
string$prefixThe common table prefix.
Renvoie:
string The processed SQL statement.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv.

Références $n, et $sql.

JDatabase::select (   $database)
abstract

Select a database for use.

Paramètres:
string$databaseThe 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 dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::setDebug (   $level)

Sets the database debugging state for the driver.

Paramètres:
boolean$levelTrue to enable debugging.
Renvoie:
boolean The old debugging level.
Depuis:
11.1

Références $debug, et debug().

Référencé par debug().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDatabase::setQuery (   $query,
  $offset = 0,
  $limit = 0 
)

Sets the SQL statement string for later execution.

Paramètres:
mixed$queryThe SQL statement to set either as a JDatabaseQuery object or a string.
integer$offsetThe affected row offset to set.
integer$limitThe maximum affected rows to set.
Renvoie:
JDatabase This object to support method chaining.
Depuis:
11.1

Références $limit, $offset, et $query.

Référencé par insertObject(), truncateTable(), et updateObject().

+ Voici le graphe des appelants de cette fonction :

JDatabase::setUTF ( )
abstract

Set the connection to use UTF-8 character encoding.

Renvoie:
boolean True on success.
Depuis:
11.1

Réimplémentée dans JDatabaseSQLSrv, JDatabaseMySQL, et JDatabaseMySQLi.

Référencé par __construct().

+ Voici le graphe des appelants de cette fonction :

static JDatabase::splitSql (   $sql)
static

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

Paramètres:
string$sqlInput SQL string with which to split into individual queries.
Renvoie:
array The queries from the input string separated into an array.
Depuis:
11.1

Références $i, $n, et $sql.

JDatabase::stderr (   $showSQL = false)

Return the most recent error message for the database connector.

Paramètres:
boolean$showSQLTrue to display the SQL statement sent to the database as well as the error.
Renvoie:
string The error message for the most recent query.
Obsolète:
12.1
Depuis:
11.1

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

+ Voici le graphe d'appel pour cette fonction :

JDatabase::transactionCommit ( )
abstract

Method to commit a transaction.

Renvoie:
void
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::transactionRollback ( )
abstract

Method to roll back a transaction.

Renvoie:
void
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::transactionStart ( )
abstract

Method to initialize a transaction.

Renvoie:
void
Depuis:
11.1
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::truncateTable (   $table)

Method to truncate a table.

Paramètres:
string$tableThe table to truncate
Renvoie:
void
Depuis:
11.3
Exceptions:
JDatabaseException

Références execute(), quoteName(), et setQuery().

+ Voici le graphe d'appel pour cette fonction :

JDatabase::unlockTables ( )
abstract

Unlocks tables in the database.

Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

Réimplémentée dans JDatabaseSQLSrv, et JDatabaseMySQL.

JDatabase::updateObject (   $table,
$object,
  $key,
  $nulls = false 
)

Updates a row in a table based on an object's properties.

Paramètres:
string$tableThe name of the database table to update.
object&$objectA reference to an object whose public properties match the table fields.
string$keyThe name of the primary key.
boolean$nullsTrue to update null fields or false to ignore them.
Renvoie:
boolean True on success.
Depuis:
11.1
Exceptions:
JDatabaseException

Références $fields, $key, execute(), null, quote(), quoteName(), et setQuery().

+ Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JDatabase::$_database
private

Référencé par getDatabase().

JDatabase::$connection
protected

Référencé par getConnection().

JDatabase::$count = 0
protected

Référencé par getCount(), et getTicker().

JDatabase::$dbMinimum
protected

Réimplémentée dans JDatabaseMySQL, et JDatabaseSQLSrv.

Référencé par getMinimum().

JDatabase::$debug = false
protected

Référencé par setDebug().

JDatabase::$errorMsg
protected

Référencé par getErrorMsg().

JDatabase::$errorNum = 0
protected

Référencé par getErrorNum().

JDatabase::$hasQuoted = false
protected
JDatabase::$instances = array()
staticprotected
JDatabase::$limit = 0
protected

Référencé par getLimit(), et setQuery().

JDatabase::$log = array()
protected

Référencé par getLog().

JDatabase::$name

Réimplémentée dans JDatabaseMySQLi, JDatabaseMySQL, JDatabaseSQLAzure, et JDatabaseSQLSrv.

Référencé par nameQuote(), et quoteName().

JDatabase::$nameQuote
protected

Réimplémentée dans JDatabaseMySQL, et JDatabaseSQLSrv.

Référencé par quoteNameStr().

JDatabase::$nullDate
protected

Réimplémentée dans JDatabaseMySQL, et JDatabaseSQLSrv.

Référencé par getNullDate().

JDatabase::$offset = 0
protected
JDatabase::$quoted = array()
protected

Référencé par addQuoted().

JDatabase::$sql
protected

Référencé par replacePrefix(), et splitSql().

JDatabase::$tablePrefix
protected

Référencé par getPrefix().

JDatabase::$utf = true
protected

Référencé par getUTFSupport().


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