Builds a new JDatabase object and initializes internal properties. Subclasses also connect to the specified database. The $options array normally includes the keys host, user, password, database, prefix, and select.

Redefines JObject::__construct(); overridden in descendant classes.

JDatabase __construct()

Runs when the JDatabase object is destroyed, ensuring that the database connection is cleanly closed.

Redefines JObject::__destruct(); overridden in descendant classes.

boolean __destruct()

This method adds a field name or an array of field names to the list of names that should always be encapsulated in quotes. Sets the protected variable $_hasQuoted to true.

void addQuoted($quoted)

This method determines if the database connection to the server is active. Redefined in descendants:

boolean connected()

This method sets the debug mode.

void debug($level)

This abstract method is a diagnostic function that explains the current query. Redefined in descendants:

void explain()

This abstract method returns the total number of records that were affected by the last query. Redefined in descendants:

integer getAffectedRows()

This abstract method returns the database collation name. This method is not infallible for MySQL databases; MySQL allows the collation to be set at four different levels, server, database, table, and column. This method returns the collation used by #__content.fulltext; it is possible that the collation may differ elsewhere in the database. This method only works if the database supports UTF-8. Redefined in descendants:

string getCollation()

This method gets an array of database driver names supported in the current environment.

array getConnectors()

This method returns the error message from the last query. If no error was encountered it returns an empty string.

string getErrorMsg([$escaped = false])

This method returns the error number from the last query. If no error was encountered it returns a 0 (zero).

integer getErrorNum()

This method returns an escaped string for use as a value in a query. Redefined in descendants:

string getEscaped($text, [$extra = false])

This method returns a reference to a global JDatabase object only creating it if it does not already exist. A separate instance will exist for each distinct set of $options. The $options array normally contains the keys defined in the constructor $options array along with the key driver. The driver key value determines the subclass that is instantiated. Currently, the core drivers that are available include MySQL and MySQLi.

JDatabase &getInstance([$options = array()])

This method returns the database error log.

array getLog()

This method returns a null date string specific to the current database driver.

string getNullDate()

This abstract method returns the number of records that were accessed by the most recent query. If $cur is specified, it will determine the number of rows that were returned for the corresponding query. This only works if the query was a SELECT, SHOW, DESCRIBE, or EXPLAIN query. Redefined in descendants:

integer getNumRows([$cur = null])

This method returns the database table prefix, normally jos_.

string getPrefix()

This method returns the active query.

string getQuery()

This abstract method returns the CREATE TABLE statement(s) for each of the table names provided. Redefined in descendants:

array getTableCreate($tables)

This abstract method returns an associative array of table field names and types for the table names provided. Redefined in descendants:

array getTableFields($tables, [$typeonly = true])

This abstract method returns an array of all the tables in the database. Redefined in descendants:

array getTableList()

This method returns the total number of queries that have been executed.

integer getTicker()

This method determines if the database supports UTF-8.

boolean getUTFSupport()

This abstract method returns the version of the database server. Redefined in descendants:

string getVersion()

This abstract method determines if the database supports UTF-8. You should use getUTFSupport() in preference to this method as it returns a cached value of hasUTF(). Redefined in descendants:

boolean hasUTF()

This abstract method returns the value of the primary key ID inserted as a result of the last query if the query was an INSERT query on a table with an auto-increment primary key. For all other queries a zero will be returned. Redefined in descendants:

integer insertid()

This abstract method inserts a row into a table based on the referenced object's properties. The referenced object's properties must match the table fields.

If the primary key field name (keyName) is specified the object will be updated with the new record's primary key value assuming the table has an auto-incremented primary key. Redefined in descendants:

boolean insertObject($table, &$object, [$keyName = null])

This method determines if the field name is among the field names that should be encapsulated in quotes. If no field names have been specified to be quoted, the method returns true.

boolean isQuoted($fieldName)

This abstract method executes the current query and returns the first row as an associative array.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

mixed loadAssoc()

This abstract method executes the current query and returns a two-dimensional array of rows. Each inner array represents a row as an associative array. If the primary key field name is provided, the outer array will be an associative array that uses the primary key value as the array key.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

mixed loadAssocList([$key = ''])

This abstract method executes the current query and returns the first row as a stdClass object.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

mixed loadObject()

This abstract method executes the current query and returns an array of stdClass objects. Each object represents a row. If the primary key field name is provided the outer array will be an associative array that uses the primary key value as the array key.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

mixed loadObjectList([$key = ''])

This abstract method executes the current query and returns the first field of the first row returned by the query.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

string loadResult()

This abstract method executes the current query and returns an array of a single field/column from the query result set. The column number is 0 (zero) based, for example, the first column = 0.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

mixed loadResultArray([$numinarray = 0])

This abstract method executes the current query and returns the first row as an array.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

mixed loadRow()

This abstract method executes the current query and returns a two-dimensional array of rows. Each inner array represents a row as an array. If the primary key field name is provided the outer array will be an associative array that uses the primary key value as the array key.

If no query has been set or the query returns an empty result set, the method will return null. Redefined in descendants:

array loadRowList([$key = ''])

This method encapsulates named SQL elements (tables, fields, databases) in quotes. The quotes used are determined by the current database driver. If the element name is using dot-notation (for example, a.b) the name will be returned unquoted.

string nameQuote($s)

This abstract method executes the current query. If the query is successful and is a SELECT, SHOW, DESCRIBE, or EXPLAIN query a database resource will be returned. If the query is successful and is not one of the prior query types the method will return true; if any query fails false will be returned. Redefined in descendants:

mixed query()

This abstract method executes a batch query. If $abort_on_error is true the batch process will stop if an error occurs. If $p_transaction_safe is true then all the queries will only be applied if they are all successful. Redefined in descendants:

mixed queryBatch([$abort_on_error = true], [$p_transaction_safe = false])

This method encapsulate $text in quotes. The quote used is determined by the current database driver. If $escaped is true $text is escaped; if false $text is not escaped.

string Quote($text, [$escaped = true])

This method replaces all occurrences of the table prefix found in the query string $sql with the value held in the $_table_prefix class variable.

string replacePrefix($sql, [$prefix = '#__'])

This method sets the next query to execute. $offset and $limit are used for pagination; in MySQL this relates directly to the LIMIT clause. If you use $offset or $limit, your SQL must not contain a LIMIT clause. $prefix is the string that is replaced by the database table prefix; it would be unusual to change this from the default #__.

void setQuery($sql, $offset = 0, $limit = 0, [$prefix = '#__'])

This abstract method prepares the database connection for UTF-8 strings. Redefined in descendants:

void setUTF()

This method splits a string of queries into an array of individual queries.

array splitSql($queries)

This method returns an error report of the last error. If $showSQL is true the SQL is included in the report.

string stderr([$showSQL = false])

This abstract method verifies that the database server connection function has been defined. For MySQL this is mysql_connect() and for MySQLi it is mysqli_connect(). Redefined in descendants:

boolean test()

This abstract method treats $object as an updated record and attempts to update the specified table from $object. If $updateNulls is true, object properties that are null will still be used to update the record in the table. Redefined in descendants:

boolean updateObject($table, &$object, $keyName, [$updateNulls = true])

This method emulates ADOdb functionality; it must be overridden in subclasses. If you intend to use this method you must ensure that the database driver supports it.

void BeginTrans()

This method emulates ADOdb functionality; it must be overridden in subclasses. If you intend to use this method you must ensure that the database driver supports it.

void CommitTrans()

This method emulates ADOdb functionality; it returns the error message from the last query; if no error was encountered, the error message will be an empty string.

string ErrorMsg()

This method emulates ADOdb functionality; it returns the error number from the last query; if no error was encountered, the error message will be zero.

integer ErrorNo()

This method emulates ADOdb functionality; it executes a query. If the query is a SELECT query the results will be returned in a JRecordSet object, if the query is not a SELECT query an empty JRecordSet will be returned upon success, and if the query fails false will be returned.

mixed Execute($query)

This method emulates ADOdb functionality; it returns a sequence ID for databases that are sequence aware (sequences are used with databases that allow multiple connections, to reduce the chance of errors). If you are creating an application that relies on sequences, ensure that the JDatabase subclass object supports GenID() fully. Subclasses must implement this method to enable GenID() support. JDatabaseMySQL and JDatabaseMySQLi do not support GenID(); using GenID() with these databases will always return 0.

mixed GenID([$foo1= null], [$foo2 = null])

This method emulates ADOdb functionality; it executes a query and returns an array of the first column from the resultant records.

array GetCol()

This method emulates ADOdb functionality; it executes a query and returns the value in the first field in the first record.

mixed GetOne($query)

This method emulates ADOdb functionality; it executes a query and returns the first row as an array.

array GetRow($query)

This method emulates ADOdb functionality; it executes a query and returns the results in a JRecordSet object.

JRecordSet PageExecute($sql, $nrows, $page, [$inputarr = false], [$sec2cache = 0])

This method emulates ADOdb functionality; it must be overridden ins subclasses. If you intend to use this method, please ensure that the database driver supports it.

void RollbackTrans()

This method emulates ADOdb functionality; it executes a query and returns the results in a JRecordSet object. The parameters $offset and $limit are used for pagination; in MySQL databases this relates directly to the LIMIT clause.

JRecordSet SelectLimit($query, $count, $offset)