Docs For Class JDatabaseDriver

JDatabaseDriver

Description

Implements interfaces:

JDatabaseInterface

Joomla Platform Database Driver Class

method: string q(): q($text, $escape = true) Alias for quote method
method: string qn(): qn($name, $as = null) Alias for quoteName method
abstract:
since: 12.1

Located in /libraries/joomla/database/driver.php (line 41)

JDatabase
   |
   --JDatabaseDriver

Direct descendents

Class	Description
JDatabaseDriverMysqli	MySQLi database driver
JDatabaseDriverPdo	Joomla Platform PDO Database Driver Class
JDatabaseDriverPostgresql	PostgreSQL database driver
JDatabaseDriverSqlsrv	SQL Server database driver

Variable Summary

static string $dbMinimum

static array $instances

array $callStacks

resource $connection

integer $count

resource $cursor

boolean $debug

callable[] $disconnectHandlers

string $errorMsg

integer $errorNum

integer $limit

array $log

string $name

string $nameQuote

string $nullDate

integer $offset

array $options

mixed $sql

string $tablePrefix

array $timings

integer $transactionDepth

boolean $utf

Method Summary

static array getConnectors ()

static JDatabaseDriver getInstance ([array $options = array()])

static array splitSql (string $sql)

JDatabaseDriver __construct (array $options)

void addDisconnectHandler (callable $callable)

string alterDbCharacterSet (string $dbName)

void connect ()

boolean connected ()

string createDatabase (stdClass $options, [boolean $utf = true])

void disconnect ()

JDatabaseDriver dropTable (string $table, [boolean $ifExists = true])

string escape (string $text, [boolean $extra = false])

mixed execute ()

mixed fetchArray ([mixed $cursor = null])

mixed fetchAssoc ([mixed $cursor = null])

mixed fetchObject ([mixed $cursor = null], [string $class = 'stdClass'])

void freeResult ([mixed $cursor = null])

integer getAffectedRows ()

string getAlterDbCharacterSet (string $dbName)

array getCallStacks ()

mixed getCollation ()

resource getConnection ()

integer getCount ()

string getCreateDatabaseQuery (stdClass $options, boolean $utf)

string getDatabase ()

string getDateFormat ()

JDatabaseExporter getExporter ()

JDatabaseImporter getImporter ()

JDatabaseIterator getIterator ([string $column = null], [string $class = 'stdClass'])

array getLog ()

string getMinimum ()

string getNullDate ()

integer getNumRows ([resource $cursor = null])

string getPrefix ()

JDatabaseQuery getQuery ([boolean $new = false])

array getTableColumns (string $table, [boolean $typeOnly = true])

array getTableCreate (mixed $tables)

array getTableKeys (mixed $tables)

array getTableList ()

array getTimings ()

boolean getUTFSupport ()

string getVersion ()

boolean hasUTFSupport ()

mixed insertid ()

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

boolean isMinimumVersion ()

mixed loadAssoc ()

mixed loadAssocList ([string $key = null], [string $column = null])

mixed loadColumn ([integer $offset = 0])

mixed loadNextObject ([string $class = 'stdClass'])

mixed loadNextRow ()

mixed loadObject ([string $class = 'stdClass'])

mixed loadObjectList ([string $key = ''], [string $class = 'stdClass'])

mixed loadResult ()

mixed loadRow ()

mixed loadRowList ([string $key = null])

JDatabaseDriver lockTable (string $tableName)

string quote (mixed $text, [boolean $escape = true])

mixed quoteName (mixed $name, [mixed $as = null])

string quoteNameStr (array $strArr)

JDatabaseDriver renameTable (string $oldTable, string $newTable, [string $backup = null], [string $prefix = null])

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

boolean select (string $database)

boolean setDebug (boolean $level)

JDatabaseDriver setQuery (mixed $query, [integer $offset = 0], [integer $limit = 0])

boolean setUTF ()

void transactionCommit ([boolean $toSavepoint = false])

void transactionRollback ([boolean $toSavepoint = false])

void transactionStart ([boolean $asSavepoint = false])

void truncateTable (string $table)

JDatabaseDriver unlockTables ()

boolean updateObject (string $table, object &$object, array $key, [boolean $nulls = false])

mixed __call (string $method, array $args)

Variables

static string $dbMinimum (line 177)

var: The minimum supported database version.
since: 12.1
access: protected

Redefined in descendants as:

JDatabaseDriverMysqli::$dbMinimum
JDatabaseDriverPostgresql::$dbMinimum : The minimum supported database version.
JDatabaseDriverSqlsrv::$dbMinimum

static array $instances = array() (line 171)

var: JDatabaseDriver instances container.
since: 11.1
access: protected

array $callStacks = array() (line 105)

var: The log of executed SQL statements timings (start and stop microtimes) by the database driver.
since: CMS 3.1.2
access: protected

resource $connection (line 63)

var: The database connection resource.
since: 11.1
access: protected

integer $count = 0 (line 69)

var: The number of SQL statements executed by the database driver.
since: 11.1
access: protected

resource $cursor (line 75)

var: The database connection cursor from the last query.
since: 11.1
access: protected

boolean $debug = false (line 81)

var: The database driver debugging state.
since: 11.1
access: protected

callable[] $disconnectHandlers = array() (line 189)

var: List of callables to call just before disconnecting database
since: CMS 3.1.2
access: protected

string $errorMsg (line 165)

var: The database error message
deprecated: 12.1
since: 11.1
access: protected

integer $errorNum = 0 (line 158)

var: The database error number
deprecated: 12.1
since: 11.1
access: protected

integer $limit = 0 (line 87)

var: The affected row limit for the current SQL statement.
since: 11.1
access: protected

array $log = array() (line 93)

var: The log of executed SQL statements by the database driver.
since: 11.1
access: protected

string $name (line 57)

The name of the database driver.

since: 11.1
access: public

Redefined in descendants as:

JDatabaseDriverMysqli::$name : The name of the database driver.
JDatabaseDriverMysql::$name : The name of the database driver.
JDatabaseDriverPdo::$name : The name of the database driver.
JDatabaseDriverOracle::$name : The name of the database driver.
JDatabaseDriverSqlite::$name : The name of the database driver.
JDatabaseDriverPostgresql::$name : The database driver name
JDatabaseDriverSqlsrv::$name : The name of the database driver.
JDatabaseDriverSqlazure::$name : The name of the database driver.

string $nameQuote (line 114)

var: The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.
since: 11.1
access: protected

Redefined in descendants as:

JDatabaseDriverMysqli::$nameQuote : The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.
JDatabaseDriverPdo::$nameQuote : The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.
JDatabaseDriverOracle::$nameQuote : The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.
JDatabaseDriverSqlite::$nameQuote : The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.
JDatabaseDriverPostgresql::$nameQuote : Quote for named objects
JDatabaseDriverSqlsrv::$nameQuote : The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.

string $nullDate (line 121)

var: The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine.
since: 11.1
access: protected

Redefined in descendants as:

JDatabaseDriverMysqli::$nullDate : The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine.
JDatabaseDriverPdo::$nullDate : The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine.
JDatabaseDriverPostgresql::$nullDate : The null/zero date string
JDatabaseDriverSqlsrv::$nullDate : The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine.

integer $offset = 0 (line 127)

var: The affected row offset to apply for the current SQL statement.
since: 11.1
access: protected

array $options (line 133)

var: Passed in upon instantiation and saved.
since: 11.1
access: protected

mixed $sql (line 139)

var: The current SQL statement to execute.
since: 11.1
access: protected

string $tablePrefix (line 145)

var: The common database table prefix.
since: 11.1
access: protected

array $timings = array() (line 99)

var: The log of executed SQL statements timings (start and stop microtimes) by the database driver.
since: CMS 3.1.2
access: protected

integer $transactionDepth = 0 (line 183)

var: The depth of the current transaction.
since: 12.3
access: protected

boolean $utf = true (line 151)

var: True if the database engine supports UTF-8 character encoding.
since: 11.1
access: protected

Methods

static getConnectors (line 200)

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.

return: An array of available database connectors.
since: 11.1
access: public

static array getConnectors ()

Redefinition of:

JDatabase::getConnectors(): 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.

static getInstance (line 255)

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.

return: A database object.
throws: RuntimeException
since: 11.1
access: public

static JDatabaseDriver getInstance ([array $options = array()])

array $options: Parameters to be passed to the database driver.

Redefinition of:

JDatabase::getInstance(): Method to return a JDatabaseDriver instance based on the given options. There are three global options and then

static splitSql (line 304)

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

return: The queries from the input string separated into an array.
since: 11.1
access: public

static array splitSql (string $sql)

string $sql: Input SQL string with which to split into individual queries.

Redefinition of:

JDatabase::splitSql(): Splits a string of multiple queries into an array of individual queries.

Constructor __construct (line 388)

Constructor.

since: 11.1
access: public

JDatabaseDriver __construct (array $options)

array $options: List of options used to configure the connection

Redefined in descendants as:

JDatabaseDriverMysqli::__construct() : Constructor.
JDatabaseDriverMysql::__construct() : Constructor.
JDatabaseDriverPdo::__construct() : Constructor.
JDatabaseDriverOracle::__construct() : Constructor.
JDatabaseDriverPostgresql::__construct() : Database object constructor
JDatabaseDriverSqlsrv::__construct() : Constructor.

addDisconnectHandler (line 494)

Adds a function callable just before disconnecting the database. Parameter of the callable is $this JDatabaseDriver

since: CMS 3.1.2
access: public

void addDisconnectHandler (callable $callable)

callable $callable: Function to call in disconnect() method just before disconnecting from database

alterDbCharacterSet (line 412)

Alter database's character set, obtaining query string from protected member.

return: The query that alter the database query string
since: 12.2
throws: RuntimeException
access: public

string alterDbCharacterSet (string $dbName)

string $dbName: The database name that will be altered

connect (line 432)

Connects to the database if needed.

return: Returns void if the database connected successfully.
abstract:
throws: RuntimeException
since: 12.1
access: public

void connect ()

Redefined in descendants as:

JDatabaseDriverMysqli::connect() : Connects to the database if needed.
JDatabaseDriverMysql::connect() : Connects to the database if needed.
JDatabaseDriverPdo::connect() : Connects to the database if needed.
JDatabaseDriverOracle::connect() : Connects to the database if needed.
JDatabaseDriverPostgresql::connect() : Connects to the database if needed.
JDatabaseDriverSqlsrv::connect() : Connects to the database if needed.

connected (line 441)

Determines if the connection to the server is active.

return: True if connected to the database engine.
abstract:
since: 11.1
access: public

boolean connected ()

Redefined in descendants as:

JDatabaseDriverMysqli::connected() : Determines if the connection to the server is active.
JDatabaseDriverMysql::connected() : Determines if the connection to the server is active.
JDatabaseDriverPdo::connected() : Determines if the connection to the server is active.
JDatabaseDriverPostgresql::connected() : Determines if the connection to the server is active.
JDatabaseDriverSqlsrv::connected() : Determines if the connection to the server is active.

createDatabase (line 456)

Create a new database using information from $options object, obtaining query string from protected member.

return: The query that creates database
since: 12.2
throws: RuntimeException
access: public

string createDatabase (stdClass $options, [boolean $utf = true])

stdClass $options: Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.
boolean $utf: True if the database supports the UTF-8 character set.

disconnect (line 483)

Disconnects the database.

abstract:
since: 12.1
access: public

void disconnect ()

Redefined in descendants as:

JDatabaseDriverMysqli::disconnect() : Disconnects the database.
JDatabaseDriverMysql::disconnect() : Disconnects the database.
JDatabaseDriverPdo::disconnect() : Disconnects the database.
JDatabaseDriverOracle::disconnect() : Disconnects the database.
JDatabaseDriverSqlite::disconnect() : Disconnects the database.
JDatabaseDriverPostgresql::disconnect() : Disconnects the database.
JDatabaseDriverSqlsrv::disconnect() : Disconnects the database.

dropTable (line 510)

Drops a table from the database.

return: Returns this object to support chaining.
abstract:
throws: RuntimeException
since: 11.4
access: public

JDatabaseDriver dropTable (string $table, [boolean $ifExists = true])

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

Redefined in descendants as:

JDatabaseDriverMysqli::dropTable() : Drops a table from the database.
JDatabaseDriverOracle::dropTable() : Drops a table from the database.
JDatabaseDriverSqlite::dropTable() : Drops a table from the database.
JDatabaseDriverPostgresql::dropTable() : Drops a table from the database.
JDatabaseDriverSqlsrv::dropTable() : Drops a table from the database.

escape (line 522)

Escapes a string for usage in an SQL statement.

return: The escaped string.
abstract:
since: 11.1
access: public

string escape (string $text, [boolean $extra = false])

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

Redefined in descendants as:

JDatabaseDriverMysqli::escape() : Method to escape a string for usage in an SQL statement.
JDatabaseDriverMysql::escape() : Method to escape a string for usage in an SQL statement.
JDatabaseDriverPdo::escape() : Method to escape a string for usage in an SQL statement.
JDatabaseDriverSqlite::escape() : Method to escape a string for usage in an SQLite statement.
JDatabaseDriverPostgresql::escape() : Method to escape a string for usage in an SQL statement.
JDatabaseDriverSqlsrv::escape() : Method to escape a string for usage in an SQL statement.

execute (line 1802)

Execute the SQL statement.

return: A database cursor resource on success, boolean false on failure.
abstract:
throws: RuntimeException
since: 12.1
access: public

mixed execute ()

Redefined in descendants as:

JDatabaseDriverMysqli::execute() : Execute the SQL statement.
JDatabaseDriverMysql::execute() : Execute the SQL statement.
JDatabaseDriverPdo::execute() : Execute the SQL statement.
JDatabaseDriverPostgresql::execute() : Execute the SQL statement.
JDatabaseDriverSqlsrv::execute() : Execute the SQL statement.

fetchArray (line 533)

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

return: Either the next row from the result set or false if there are no more rows.
abstract:
since: 11.1
access: protected

mixed fetchArray ([mixed $cursor = null])

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

Redefined in descendants as:

JDatabaseDriverMysqli::fetchArray() : Method to fetch a row from the result set cursor as an array.
JDatabaseDriverMysql::fetchArray() : Method to fetch a row from the result set cursor as an array.
JDatabaseDriverPdo::fetchArray() : Method to fetch a row from the result set cursor as an array.
JDatabaseDriverPostgresql::fetchArray() : Method to fetch a row from the result set cursor as an array.
JDatabaseDriverSqlsrv::fetchArray() : Method to fetch a row from the result set cursor as an array.

fetchAssoc (line 544)

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

return: Either the next row from the result set or false if there are no more rows.
abstract:
since: 11.1
access: protected

mixed fetchAssoc ([mixed $cursor = null])

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

Redefined in descendants as:

JDatabaseDriverMysqli::fetchAssoc() : Method to fetch a row from the result set cursor as an associative array.
JDatabaseDriverMysql::fetchAssoc() : Method to fetch a row from the result set cursor as an associative array.
JDatabaseDriverPdo::fetchAssoc() : Method to fetch a row from the result set cursor as an associative array.
JDatabaseDriverPostgresql::fetchAssoc() : Method to fetch a row from the result set cursor as an associative array.
JDatabaseDriverSqlsrv::fetchAssoc() : Method to fetch a row from the result set cursor as an associative array.

fetchObject (line 556)

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

return: Either the next row from the result set or false if there are no more rows.
abstract:
since: 11.1
access: protected

mixed fetchObject ([mixed $cursor = null], [string $class = 'stdClass'])

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.

Redefined in descendants as:

JDatabaseDriverMysqli::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseDriverMysql::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseDriverPdo::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseDriverPostgresql::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseDriverSqlsrv::fetchObject() : Method to fetch a row from the result set cursor as an object.

freeResult (line 567)

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

abstract:
since: 11.1
access: protected

void freeResult ([mixed $cursor = null])

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

Redefined in descendants as:

JDatabaseDriverMysqli::freeResult() : Method to free up the memory used for the result set.
JDatabaseDriverMysql::freeResult() : Method to free up the memory used for the result set.
JDatabaseDriverPdo::freeResult() : Method to free up the memory used for the result set.
JDatabaseDriverPostgresql::freeResult() : Method to free up the memory used for the result set.
JDatabaseDriverSqlsrv::freeResult() : Method to free up the memory used for the result set.

getAffectedRows (line 576)

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

return: The number of affected rows.
abstract:
since: 11.1
access: public

integer getAffectedRows ()

Redefined in descendants as:

JDatabaseDriverMysqli::getAffectedRows() : Get the number of affected rows for the previous executed SQL statement.
JDatabaseDriverMysql::getAffectedRows() : Get the number of affected rows for the previous executed SQL statement.
JDatabaseDriverPdo::getAffectedRows() : Get the number of affected rows for the previous executed SQL statement.
JDatabaseDriverPostgresql::getAffectedRows() : Get the number of affected rows for the previous executed SQL statement.
JDatabaseDriverSqlsrv::getAffectedRows() : Get the number of affected rows for the previous executed SQL statement.

getAlterDbCharacterSet (line 587)

Return the query string to alter the database character set.

return: The query that alter the database query string
since: 12.2
access: protected

string getAlterDbCharacterSet (string $dbName)

string $dbName: The database name

Redefined in descendants as:

JDatabaseDriverPostgresql::getAlterDbCharacterSet() : Get the query string to alter the database character set.

getCallStacks (line 702)

Get the database driver SQL statement log.

return: SQL statements executed by the database driver.
since: CMS 3.1.2
access: public

array getCallStacks ()

getCollation (line 620)

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

return: The collation in use by the database or boolean false if not supported.
abstract:
since: 11.1
access: public

mixed getCollation ()

Redefined in descendants as:

JDatabaseDriverMysqli::getCollation() : Method to get the database collation in use by sampling a text field of a table in the database.
JDatabaseDriverOracle::getCollation() : Method to get the database collation in use by sampling a text field of a table in the database.
JDatabaseDriverSqlite::getCollation() : Method to get the database collation in use by sampling a text field of a table in the database.
JDatabaseDriverPostgresql::getCollation() : Method to get the database collation in use by sampling a text field of a table in the database.
JDatabaseDriverSqlsrv::getCollation() : Method to get the database collation in use by sampling a text field of a table in the database.

getConnection (line 630)

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.

return: The underlying database connection resource.
since: 11.1
access: public

resource getConnection ()

getCount (line 642)

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

since: 11.1
access: public

integer getCount ()

getCreateDatabaseQuery (line 604)

Return the query string to create new Database.

Each database driver, other than MySQL, need to override this member to return correct string.

return: The query that creates database
since: 12.2
access: protected

string getCreateDatabaseQuery (stdClass $options, boolean $utf)

stdClass $options: Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.
boolean $utf: True if the database supports the UTF-8 character set.

getDatabase (line 654)

Gets the name of the database used by this conneciton.

since: 11.4
access: protected

string getDatabase ()

getDateFormat (line 666)

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

return: The format string.
since: 11.1
access: public

string getDateFormat ()

Redefined in descendants as:

JDatabaseDriverOracle::getDateFormat() : Returns the current date format

getExporter (line 762)

Gets an exporter class object.

return: An exporter object.
since: 12.1
throws: RuntimeException
access: public

JDatabaseExporter getExporter ()

getImporter (line 788)

Gets an importer class object.

return: An importer object.
since: 12.1
throws: RuntimeException
access: public

JDatabaseImporter getImporter ()

getIterator (line 849)

Get a new iterator on the current query.

return: A new database iterator.
since: 12.1
throws: RuntimeException
access: public

JDatabaseIterator getIterator ([string $column = null], [string $class = 'stdClass'])

string $column: An option column to use as the iterator key.
string $class: The class of object that is returned.

getLog (line 678)

Get the database driver SQL statement log.

return: SQL statements executed by the database driver.
since: 11.1
access: public

array getLog ()

getMinimum (line 714)

Get the minimum supported database version.

return: The minimum version number for the database driver.
since: 12.1
access: public

string getMinimum ()

getNullDate (line 726)

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

return: Null or zero representation of a timestamp.
since: 11.1
access: public

string getNullDate ()

getNumRows (line 740)

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

return: The number of returned rows.
abstract:
since: 11.1
access: public

integer getNumRows ([resource $cursor = null])

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

Redefined in descendants as:

JDatabaseDriverMysqli::getNumRows() : Get the number of returned rows for the previous executed SQL statement.
JDatabaseDriverMysql::getNumRows() : Get the number of returned rows for the previous executed SQL statement.
JDatabaseDriverPdo::getNumRows() : Get the number of returned rows for the previous executed SQL statement.
JDatabaseDriverPostgresql::getNumRows() : Get the number of returned rows for the previous executed SQL statement.
JDatabaseDriverSqlsrv::getNumRows() : Get the number of returned rows for the previous executed SQL statement.

getPrefix (line 749)

Get the common table prefix for the database driver.

return: The common database table prefix.
since: 11.1
access: public

string getPrefix ()

getQuery (line 816)

Get the current query object or a new JDatabaseQuery object.

return: The current query object or a new object extending the JDatabaseQuery class.
since: 11.1
throws: RuntimeException
access: public

JDatabaseQuery getQuery ([boolean $new = false])

boolean $new: False to return the current query object, True to return a new JDatabaseQuery object.

Redefined in descendants as:

JDatabaseDriverPostgresql::getQuery() : Get the current or query, or new JDatabaseQuery object.

getTableColumns (line 876)

Retrieves field information about the given tables.

return: An array of fields by table.
abstract:
throws: RuntimeException
since: 11.1
access: public

array getTableColumns (string $table, [boolean $typeOnly = true])

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

Redefined in descendants as:

JDatabaseDriverMysqli::getTableColumns() : Retrieves field information about a given table.
JDatabaseDriverOracle::getTableColumns() : Retrieves field information about a given table.
JDatabaseDriverSqlite::getTableColumns() : Retrieves field information about a given table.
JDatabaseDriverPostgresql::getTableColumns() : Retrieves field information about a given table.
JDatabaseDriverSqlsrv::getTableColumns() : Retrieves field information about the given tables.

getTableCreate (line 888)

Shows the table CREATE statement that creates the given tables.

return: A list of the create SQL for the tables.
abstract:
throws: RuntimeException
since: 11.1
access: public

array getTableCreate (mixed $tables)

mixed $tables: A table name or a list of table names.

Redefined in descendants as:

JDatabaseDriverMysqli::getTableCreate() : Shows the table CREATE statement that creates the given tables.
JDatabaseDriverOracle::getTableCreate() : Shows the table CREATE statement that creates the given tables.
JDatabaseDriverSqlite::getTableCreate() : Shows the table CREATE statement that creates the given tables.
JDatabaseDriverPostgresql::getTableCreate() : Shows the table CREATE statement that creates the given tables.
JDatabaseDriverSqlsrv::getTableCreate() : Shows the table CREATE statement that creates the given tables.

getTableKeys (line 900)

Retrieves field information about the given tables.

return: An array of keys for the table(s).
abstract:
throws: RuntimeException
since: 11.1
access: public

array getTableKeys (mixed $tables)

mixed $tables: A table name or a list of table names.

Redefined in descendants as:

JDatabaseDriverMysqli::getTableKeys() : Get the details list of keys for a table.
JDatabaseDriverOracle::getTableKeys() : Get the details list of keys for a table.
JDatabaseDriverSqlite::getTableKeys() : Get the details list of keys for a table.
JDatabaseDriverPostgresql::getTableKeys() : Get the details list of keys for a table.
JDatabaseDriverSqlsrv::getTableKeys() : Get the details list of keys for a table.

getTableList (line 910)

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

return: An array of all the tables in the database.
abstract:
throws: RuntimeException
since: 11.1
access: public

array getTableList ()

Redefined in descendants as:

JDatabaseDriverMysqli::getTableList() : Method to get an array of all tables in the database.
JDatabaseDriverOracle::getTableList() : Method to get an array of all tables in the database (schema).
JDatabaseDriverSqlite::getTableList() : Method to get an array of all tables in the database (schema).
JDatabaseDriverPostgresql::getTableList() : Method to get an array of all tables in the database.
JDatabaseDriverSqlsrv::getTableList() : Method to get an array of all tables in the database.

getTimings (line 690)

Get the database driver SQL statement log.

return: SQL statements executed by the database driver.
since: CMS 3.1.2
access: public

array getTimings ()

getUTFSupport (line 920)

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

return: True if the database engine supports UTF-8 character encoding.
deprecated: 12.3 (Platform) & 4.0 (CMS) - Use hasUTFSupport() instead
since: 11.1
access: public

boolean getUTFSupport ()

getVersion (line 945)

Get the version of the database connector

return: The database connector version.
abstract:
since: 11.1
access: public

string getVersion ()

Redefined in descendants as:

JDatabaseDriverMysqli::getVersion() : Get the version of the database connector.
JDatabaseDriverMysql::getVersion() : Get the version of the database connector.
JDatabaseDriverOracle::getVersion() : Get the version of the database connector.
JDatabaseDriverSqlite::getVersion() : Get the version of the database connector.
JDatabaseDriverPostgresql::getVersion() : Get the version of the database connector.
JDatabaseDriverSqlsrv::getVersion() : Get the version of the database connector.

hasUTFSupport (line 933)

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

return: True if the database engine supports UTF-8 character encoding.
since: 12.1
access: public

boolean hasUTFSupport ()

insertid (line 954)

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

return: The value of the auto-increment field from the last inserted row.
abstract:
since: 11.1
access: public

mixed insertid ()

Redefined in descendants as:

JDatabaseDriverMysqli::insertid() : Method to get the auto-incremented value from the last INSERT statement.
JDatabaseDriverMysql::insertid() : Method to get the auto-incremented value from the last INSERT statement.
JDatabaseDriverPdo::insertid() : Method to get the auto-incremented value from the last INSERT statement.
JDatabaseDriverPostgresql::insertid() : Method to get the auto-incremented value from the last INSERT statement.
JDatabaseDriverSqlsrv::insertid() : Method to get the auto-incremented value from the last INSERT statement.

insertObject (line 968)

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

return: True on success.
since: 11.1
throws: RuntimeException
access: public

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

string $table: The name of the database table to insert into.
object &$object: A reference to an object whose public properties match the table fields.
string $key: The name of the primary key. If provided the object property is updated.

Redefined in descendants as:

JDatabaseDriverPostgresql::insertObject() : Inserts a row into a table based on an object's properties.
JDatabaseDriverSqlsrv::insertObject() : Inserts a row into a table based on an object's properties.

isMinimumVersion (line 1025)

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

return: True if the database version is supported
since: 12.1
access: public

boolean isMinimumVersion ()

loadAssoc (line 1039)

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

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadAssoc ()

loadAssocList (line 1080)

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.

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadAssocList ([string $key = null], [string $column = null])

string $key: The name of a field on which to key the result array.
string $column: An optional column name. Instead of the whole row, only this column value will be in the result array.

loadColumn (line 1124)

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

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadColumn ([integer $offset = 0])

integer $offset: The row offset to use to build the result array.

loadNextObject (line 1158)

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

return: The result of the query as an array, false if there are no more rows.
since: 11.1
throws: RuntimeException
access: public

mixed loadNextObject ([string $class = 'stdClass'])

string $class: The class name to use for the returned row object.

Redefined in descendants as:

JDatabaseDriverPdo::loadNextObject() : Method to get the next row in the result set from the database query as an object.

loadNextRow (line 1196)

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

return: The result of the query as an array, false if there are no more rows.
deprecated: N/A (CMS) Use JDatabaseDriver::getIterator() instead
throws: RuntimeException
since: 11.1
access: public

mixed loadNextRow ()

Redefined in descendants as:

JDatabaseDriverPdo::loadNextRow() : Method to get the next row in the result set from the database query as an array.

loadObject (line 1235)

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

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadObject ([string $class = 'stdClass'])

string $class: The class name to use for the returned row object.

loadObjectList (line 1274)

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.

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadObjectList ([string $key = ''], [string $class = 'stdClass'])

string $key: The name of a field on which to key the result array.
string $class: The class name to use for the returned row objects.

loadResult (line 1313)

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

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadResult ()

Redefined in descendants as:

JDatabaseDriverSqlsrv::loadResult() : Method to get the first field of the first row of the result set from the database query.

loadRow (line 1346)

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.

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadRow ()

loadRowList (line 1384)

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.

return: The return value or null if the query failed.
since: 11.1
throws: RuntimeException
access: public

mixed loadRowList ([string $key = null])

string $key: The name of a field on which to key the result array.

lockTable (line 1425)

Locks a table in the database.

return: Returns this object to support chaining.
abstract:
throws: RuntimeException
since: 11.4
access: public

JDatabaseDriver lockTable (string $tableName)

string $tableName: The name of the table to unlock.

Redefined in descendants as:

JDatabaseDriverMysqli::lockTable() : Locks a table in the database.
JDatabaseDriverOracle::lockTable() : Locks a table in the database.
JDatabaseDriverSqlite::lockTable() : Locks a table in the database.
JDatabaseDriverPostgresql::lockTable() : Locks a table in the database.
JDatabaseDriverSqlsrv::lockTable() : Locks a table in the database.

quote (line 1438)

Quotes and optionally escapes a string to database requirements for use in database queries.

return: The quoted input string.
since: 11.1
access: public

string quote (mixed $text, [boolean $escape = true])

mixed $text: A string or an array of strings to quote.
boolean $escape: True (default) to escape the string, false to leave it unchanged.

quoteName (line 1468)

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

return: The quote wrapped name, same type of $name.
since: 11.1
access: public

mixed quoteName (mixed $name, [mixed $as = null])

mixed $name: The identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.
mixed $as: The 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.

quoteNameStr (line 1518)

Quote strings coming from quoteName call.

return: Dot-imploded string of quoted parts.
since: 11.3
access: protected

string quoteNameStr (array $strArr)

array $strArr: Array of strings coming from quoteName dot-explosion.

renameTable (line 1591)

Renames a table in the database.

return: Returns this object to support chaining.
abstract:
throws: RuntimeException
since: 11.4
access: public

JDatabaseDriver renameTable (string $oldTable, string $newTable, [string $backup = null], [string $prefix = null])

string $oldTable: The name of the table to be renamed
string $newTable: The new name for the table.
string $backup: Table prefix
string $prefix: For the table - used to rename constraints in non-mysql databases

Redefined in descendants as:

JDatabaseDriverMysqli::renameTable() : Renames a table in the database.
JDatabaseDriverOracle::renameTable() : Renames a table in the database.
JDatabaseDriverSqlite::renameTable() : Renames a table in the database.
JDatabaseDriverPostgresql::renameTable() : Renames a table in the database.
JDatabaseDriverSqlsrv::renameTable() : Renames a table in the database.

replacePrefix (line 1554)

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

return: The processed SQL statement.
since: 11.1
access: public

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

string $sql: The SQL statement to prepare.
string $prefix: The common table prefix.

Redefined in descendants as:

JDatabaseDriverOracle::replacePrefix() : This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.
JDatabaseDriverPostgresql::replacePrefix() : This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.
JDatabaseDriverSqlsrv::replacePrefix() : This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.

select (line 1603)

Select a database for use.

return: True if the database was successfully selected.
abstract:
throws: RuntimeException
since: 11.1
access: public

boolean select (string $database)

string $database: The name of the database to select for use.

Redefined in descendants as:

JDatabaseDriverMysqli::select() : Select a database for use.
JDatabaseDriverMysql::select() : Select a database for use.
JDatabaseDriverPdo::select() : Select a database for use.
JDatabaseDriverOracle::select() : Select a database for use.
JDatabaseDriverSqlite::select() : Select a database for use.
JDatabaseDriverPostgresql::select() : Selects the database, but redundant for PostgreSQL
JDatabaseDriverSqlsrv::select() : Select a database for use.

setDebug (line 1614)

Sets the database debugging state for the driver.

return: The old debugging level.
since: 11.1
access: public

boolean setDebug (boolean $level)

boolean $level: True to enable debugging.

setQuery (line 1633)

Sets the SQL statement string for later execution.

return: This object to support method chaining.
since: 11.1
access: public

JDatabaseDriver setQuery (mixed $query, [integer $offset = 0], [integer $limit = 0])

mixed $query: The SQL statement to set either as a JDatabaseQuery object or a string.
integer $offset: The affected row offset to set.
integer $limit: The maximum affected rows to set.

Redefined in descendants as:

JDatabaseDriverPdo::setQuery() : Sets the SQL statement string for later execution.

setUTF (line 1657)

Set the connection to use UTF-8 character encoding.

return: True on success.
abstract:
since: 11.1
access: public

boolean setUTF ()

Redefined in descendants as:

JDatabaseDriverMysqli::setUTF() : Set the connection to use UTF-8 character encoding.
JDatabaseDriverMysql::setUTF() : Set the connection to use UTF-8 character encoding.
JDatabaseDriverPdo::setUTF() : Set the connection to use UTF-8 character encoding.
JDatabaseDriverOracle::setUTF() : Set the connection to use UTF-8 character encoding.
JDatabaseDriverSqlite::setUTF() : Set the connection to use UTF-8 character encoding.
JDatabaseDriverPostgresql::setUTF() : Custom settings for UTF support
JDatabaseDriverSqlsrv::setUTF() : Set the connection to use UTF-8 character encoding.

transactionCommit (line 1669)

Method to commit a transaction.

abstract:
throws: RuntimeException
since: 11.1
access: public

void transactionCommit ([boolean $toSavepoint = false])

boolean $toSavepoint: If true, commit to the last savepoint.

Redefined in descendants as:

JDatabaseDriverMysqli::transactionCommit() : Method to commit a transaction.
JDatabaseDriverPdo::transactionCommit() : Method to commit a transaction.
JDatabaseDriverOracle::transactionCommit() : Method to commit a transaction.
JDatabaseDriverSqlite::transactionCommit() : Method to commit a transaction.
JDatabaseDriverPostgresql::transactionCommit() : Method to commit a transaction.
JDatabaseDriverSqlsrv::transactionCommit() : Method to commit a transaction.

transactionRollback (line 1681)

Method to roll back a transaction.

abstract:
throws: RuntimeException
since: 11.1
access: public

void transactionRollback ([boolean $toSavepoint = false])

boolean $toSavepoint: If true, rollback to the last savepoint.

Redefined in descendants as:

JDatabaseDriverMysqli::transactionRollback() : Method to roll back a transaction.
JDatabaseDriverPdo::transactionRollback() : Method to roll back a transaction.
JDatabaseDriverOracle::transactionRollback() : Method to roll back a transaction.
JDatabaseDriverSqlite::transactionRollback() : Method to roll back a transaction.
JDatabaseDriverPostgresql::transactionRollback() : Method to roll back a transaction.
JDatabaseDriverSqlsrv::transactionRollback() : Method to roll back a transaction.

transactionStart (line 1693)

Method to initialize a transaction.

abstract:
throws: RuntimeException
since: 11.1
access: public

void transactionStart ([boolean $asSavepoint = false])

boolean $asSavepoint: If true and a transaction is already active, a savepoint will be created.

Redefined in descendants as:

JDatabaseDriverMysqli::transactionStart() : Method to initialize a transaction.
JDatabaseDriverPdo::transactionStart() : Method to initialize a transaction.
JDatabaseDriverOracle::transactionStart() : Method to initialize a transaction.
JDatabaseDriverSqlite::transactionStart() : Method to initialize a transaction.
JDatabaseDriverPostgresql::transactionStart() : Method to initialize a transaction.
JDatabaseDriverSqlsrv::transactionStart() : Method to initialize a transaction.

truncateTable (line 1705)

Method to truncate a table.

since: 11.3
throws: RuntimeException
access: public

void truncateTable (string $table)

string $table: The table to truncate

unlockTables (line 1812)

Unlocks tables in the database.

return: Returns this object to support chaining.
abstract:
throws: RuntimeException
since: 11.4
access: public

JDatabaseDriver unlockTables ()

Redefined in descendants as:

JDatabaseDriverMysqli::unlockTables() : Unlocks tables in the database.
JDatabaseDriverOracle::unlockTables() : Unlocks tables in the database.
JDatabaseDriverSqlite::unlockTables() : Unlocks tables in the database.
JDatabaseDriverPostgresql::unlockTables() : Unlocks tables in the database, this command does not exist in PostgreSQL, it is automatically done on commit or rollback.
JDatabaseDriverSqlsrv::unlockTables() : Unlocks tables in the database.

updateObject (line 1724)

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

return: True on success.
since: 11.1
throws: RuntimeException
access: public

boolean updateObject (string $table, object &$object, array $key, [boolean $nulls = false])

string $table: The name of the database table to update.
object &$object: A reference to an object whose public properties match the table fields.
array $key: The name of the primary key.
boolean $nulls: True to update null fields or false to ignore them.

Redefined in descendants as:

JDatabaseDriverPostgresql::updateObject() : Updates a row in a table based on an object's properties.

__call (line 363)

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

return: The aliased method's return value or null.
since: 11.1
access: public

mixed __call (string $method, array $args)

string $method: The called method.
array $args: The array of arguments passed to the method.

Inherited Methods

Inherited From JDatabase

JDatabase::getConnectors()
JDatabase::getErrorMsg()
JDatabase::getErrorNum()
JDatabase::getInstance()
JDatabase::query()
JDatabase::splitSql()
JDatabase::stderr()
JDatabase::test()

Documentation generated on Tue, 19 Nov 2013 15:01:42 +0100 by phpDocumentor 1.4.3