JDatabaseDriverPdo
Joomla Platform PDO Database Driver Class
Located in /libraries/joomla/database/driver/pdo.php (line 20)
JDatabase | --JDatabaseDriver | --JDatabaseDriverPdo
| Class | Description |
|---|---|
JDatabaseDriverOracle
|
Oracle database driver |
|
JDatabaseDriverSqlite
|
SQLite database driver |
static 
JDatabaseDriver
setQuery
(mixed $query, [integer $offset = null], [integer $limit = null], [array $driverOptions = array()])
array
$executed
= false (line 62)
Contains the current query execution status
string
$name
= 'pdo' (line 28)
The name of the database driver.
- JDatabaseDriver::$name
- The name of the database driver.
- JDatabaseDriverOracle::$name : The name of the database driver.
- JDatabaseDriverSqlite::$name : The name of the database driver.
string
$nameQuote
= "'" (line 39)
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.
string
$nullDate
= '0000-00-00 00:00:00' (line 48)
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.
resource
$prepared
(line 54)
Inherited Variables
Inherited from JDatabaseDriver
Test to see if the PDO extension is available.
Override as needed to check for specific PDO Drivers.
- JDatabaseDriverOracle::isSupported() : Test to see if the PDO ODBC connector is available.
- JDatabaseDriverSqlite::isSupported() : Test to see if the PDO ODBC connector is available.
Constructor.
- array $options: List of options used to configure the connection
- JDatabaseDriver::__construct()
- Constructor.
- JDatabaseDriverOracle::__construct() : Constructor.
Destructor.
- JDatabaseDriverOracle::__destruct() : Destructor.
- JDatabaseDriverSqlite::__destruct() : Destructor.
Connects to the database if needed.
- JDatabaseDriver::connect()
- Connects to the database if needed.
- JDatabaseDriverOracle::connect() : Connects to the database if needed.
Determines if the connection to the server is active.
- JDatabaseDriver::connected()
- Determines if the connection to the server is active.
Disconnects the database.
- JDatabaseDriver::disconnect()
- Disconnects the database.
- JDatabaseDriverOracle::disconnect() : Disconnects the database.
- JDatabaseDriverSqlite::disconnect() : Disconnects the database.
Method to escape a string for usage in an SQL statement.
Oracle escaping reference: http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F
SQLite escaping notes: http://www.sqlite.org/faq.html#q14
Method body is as implemented by the Zend Framework
Note: Using query objects with bound variables is preferable to the below.
- string $text: The string to be escaped.
- boolean $extra: Unused optional parameter to provide extra escaping.
- JDatabaseDriver::escape()
- Escapes a string for usage in an SQL statement.
- JDatabaseDriverSqlite::escape() : Method to escape a string for usage in an SQLite statement.
Execute the SQL statement.
- JDatabaseDriver::execute()
- Execute the SQL statement.
Method to fetch a row from the result set cursor as an array.
- mixed $cursor: The optional result set cursor from which to fetch the row.
- JDatabaseDriver::fetchArray()
- Method to fetch a row from the result set cursor as an array.
Method to fetch a row from the result set cursor as an associative array.
- mixed $cursor: The optional result set cursor from which to fetch the row.
- JDatabaseDriver::fetchAssoc()
- Method to fetch a row from the result set cursor as an associative array.
Method to fetch a row from the result set cursor as an object.
- mixed $cursor: The optional result set cursor from which to fetch the row.
- string $class: Unused, only necessary so method signature will be the same as parent.
- JDatabaseDriver::fetchObject()
- Method to fetch a row from the result set cursor as an object.
Method to free up the memory used for the result set.
- mixed $cursor: The optional result set cursor from which to fetch the row.
- JDatabaseDriver::freeResult()
- Method to free up the memory used for the result set.
Get the number of affected rows for the previous executed SQL statement.
Only applicable for DELETE, INSERT, or UPDATE statements.
- JDatabaseDriver::getAffectedRows()
- Get the number of affected rows for the previous executed SQL statement.
Get a query to run and verify the database is operational.
- JDatabaseDriverOracle::getConnectedQuery() : Get a query to run and verify the database is operational.
Get the number of returned rows for the previous executed SQL statement.
- resource $cursor: An optional database cursor resource to extract the row count from.
- JDatabaseDriver::getNumRows()
- Get the number of returned rows for the previous executed SQL statement.
Retrieve a PDO database connection attribute http://www.php.net/manual/en/pdo.getattribute.php
Usage: $db->getOption(PDO::ATTR_CASE);
- mixed $key: One of the PDO::ATTR_* Constants
Method to get the auto-incremented value from the last INSERT statement.
- JDatabaseDriver::insertid()
- Method to get the auto-incremented value from the last INSERT statement.
Method to get the next row in the result set from the database query as an array.
Method to get the next row in the result set from the database query as an object.
- string $class: The class name to use for the returned row object.
- JDatabaseDriver::loadNextObject()
- Method to get the next row in the result set from the database query as an object.
Method to get the next row in the result set from the database query as an array.
- JDatabaseDriver::loadNextRow()
- Method to get the next row in the result set from the database query as an array.
Select a database for use.
- string $database: The name of the database to select for use.
- JDatabaseDriver::select()
- Select a database for use.
- JDatabaseDriverOracle::select() : Select a database for use.
- JDatabaseDriverSqlite::select() : Select a database for use.
Sets an attribute on the PDO database handle.
http://www.php.net/manual/en/pdo.setattribute.php
Usage: $db->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
- integer $key: One of the PDO::ATTR_* Constants
- mixed $value: One of the associated PDO Constants related to the particular attribute key.
Sets the SQL statement string for later execution.
- 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.
- array $driverOptions: The optional PDO driver options
- JDatabaseDriver::setQuery()
- Sets the SQL statement string for later execution.
Set the connection to use UTF-8 character encoding.
- JDatabaseDriver::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.
Method to commit a transaction.
- boolean $toSavepoint: If true, commit to the last savepoint.
- JDatabaseDriver::transactionCommit()
- Method to commit a transaction.
- JDatabaseDriverOracle::transactionCommit() : Method to commit a transaction.
- JDatabaseDriverSqlite::transactionCommit() : Method to commit a transaction.
Method to roll back a transaction.
- boolean $toSavepoint: If true, rollback to the last savepoint.
- JDatabaseDriver::transactionRollback()
- Method to roll back a transaction.
- JDatabaseDriverOracle::transactionRollback() : Method to roll back a transaction.
- JDatabaseDriverSqlite::transactionRollback() : Method to roll back a transaction.
Method to initialize a transaction.
- boolean $asSavepoint: If true and a transaction is already active, a savepoint will be created.
- JDatabaseDriver::transactionStart()
- Method to initialize a transaction.
- JDatabaseDriverOracle::transactionStart() : Method to initialize a transaction.
- JDatabaseDriverSqlite::transactionStart() : Method to initialize a transaction.
Inherited Methods
Inherited From JDatabaseDriver
JDatabaseDriver::__construct()
JDatabaseDriver::connect()
Inherited From JDatabase
Documentation generated on Tue, 19 Nov 2013 15:10:27 +0100 by phpDocumentor 1.4.3