Class FOFDatabaseDriverPdo

Joomla Platform PDO Database Driver Class

FOFDatabase

FOFDatabaseDriver implements FOFDatabaseInterface

FOFDatabaseDriverPdo

Direct known subclasses

FOFDatabaseDriverOracle, FOFDatabaseDriverPdomysql, FOFDatabaseDriverSqlite

Abstract
Package: FrameworkOnFramework\database
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects instead of plain stdClass objects
Since: 12.1
See: http://php.net/pdo
Located at fof/database/driver/pdo.php

Methods summary

`public`	# `__construct( array $options )` Constructor. Constructor. Parameters `$options` `array` - $options List of options used to configure the connection Since 12.1 Overrides `FOFDatabaseDriver::__construct`
`public`	# `__destruct( )` Destructor. Destructor. Since 12.1
`public`	# `connect( )` Connects to the database if needed. Connects to the database if needed. Returns - Returns void if the database connected successfully. Throws `RuntimeException` Since 12.1
`public`	# `disconnect( )` Disconnects the database. Disconnects the database. Since 12.1
`public string`	# `escape( string $text, boolean $extra = false )` Method to escape a string for usage in an SQL statement. 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. Parameters `$text` `string` - $text The string to be escaped. `$extra` `boolean` - $extra Unused optional parameter to provide extra escaping. Returns `string` - The escaped string. Since 12.1
`public mixed`	# `execute( )` Execute the SQL statement. Execute the SQL statement. Returns `mixed` - A database cursor resource on success, boolean false on failure. Throws `RuntimeException` `Exception` Since 12.1
`public mixed`	# `getOption( mixed $key )` Retrieve a PDO database connection attribute http://www.php.net/manual/en/pdo.getattribute.php Retrieve a PDO database connection attribute http://www.php.net/manual/en/pdo.getattribute.php Usage: $db->getOption(PDO::ATTR_CASE); Parameters `$key` `mixed` - $key One of the PDO::ATTR_* Constants Returns `mixed` Since 12.1
`public string`	# `getConnectedQuery( )` Get a query to run and verify the database is operational. Get a query to run and verify the database is operational. Returns `string` - The query to check the health of the DB. Since 12.2
`public boolean`	# `setOption( integer $key, mixed $value )` Sets an attribute on the PDO database handle. http://www.php.net/manual/en/pdo.setattribute.php 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); Parameters `$key` `integer` - $key One of the PDO::ATTR_* Constants `$value` `mixed` - $value One of the associated PDO Constants related to the particular attribute key. Returns `boolean` Since 12.1
`public static boolean`	# `isSupported( )` Test to see if the PDO extension is available. Override as needed to check for specific PDO Drivers. Test to see if the PDO extension is available. Override as needed to check for specific PDO Drivers. Returns `boolean` - True on success, false otherwise. Since 12.1
`public boolean`	# `connected( )` Determines if the connection to the server is active. Determines if the connection to the server is active. Returns `boolean` - True if connected to the database engine. Since 12.1
`public integer`	# `getAffectedRows( )` Get the number of affected rows for the previous executed SQL statement. Only applicable for DELETE, INSERT, or UPDATE statements. Get the number of affected rows for the previous executed SQL statement. Only applicable for DELETE, INSERT, or UPDATE statements. Returns `integer` - The number of affected rows. Since 12.1
`public integer`	# `getNumRows( resource $cursor = null )` Get the number of returned rows for the previous executed SQL statement. Only applicable for DELETE, INSERT, or UPDATE statements. Get the number of returned rows for the previous executed SQL statement. Only applicable for DELETE, INSERT, or UPDATE statements. Parameters `$cursor` `resource` - $cursor An optional database cursor resource to extract the row count from. Returns `integer` - The number of returned rows. Since 12.1
`public string`	# `insertid( )` Method to get the auto-incremented value from the last INSERT statement. Method to get the auto-incremented value from the last INSERT statement. Returns `string` - The value of the auto-increment field from the last inserted row. Since 12.1
`public boolean`	# `select( string $database )` Select a database for use. Select a database for use. Parameters `$database` `string` - $database The name of the database to select for use. Returns `boolean` - True if the database was successfully selected. Throws `RuntimeException` Since 12.1
`public FOFDatabaseDriver`	# `setQuery( mixed $query, integer $offset = null, integer $limit = null, array $driverOptions = array() )` Sets the SQL statement string for later execution. Sets the SQL statement string for later execution. Parameters `$query` `mixed` - $query The SQL statement to set either as a FOFDatabaseQuery object or a string. `$offset` `integer` - $offset The affected row offset to set. `$limit` `integer` - $limit The maximum affected rows to set. `$driverOptions` `array` - $driverOptions The optional PDO driver options. Returns `FOFDatabaseDriver` - This object to support method chaining. Since 12.1 Overrides `FOFDatabaseDriver::setQuery`
`public boolean`	# `setUtf( )` Set the connection to use UTF-8 character encoding. Set the connection to use UTF-8 character encoding. Returns `boolean` - True on success. Since 12.1
`public`	# `transactionCommit( boolean $toSavepoint = false )` Method to commit a transaction. Method to commit a transaction. Parameters `$toSavepoint` `boolean` - $toSavepoint If true, commit to the last savepoint. Throws `RuntimeException` Since 12.1
`public`	# `transactionRollback( boolean $toSavepoint = false )` Method to roll back a transaction. Method to roll back a transaction. Parameters `$toSavepoint` `boolean` - $toSavepoint If true, rollback to the last savepoint. Throws `RuntimeException` Since 12.1
`public`	# `transactionStart( boolean $asSavepoint = false )` Method to initialize a transaction. Method to initialize a transaction. Parameters `$asSavepoint` `boolean` - $asSavepoint If true and a transaction is already active, a savepoint will be created. Throws `RuntimeException` Since 12.1
`protected mixed`	# `fetchArray( mixed $cursor = null )` 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 array. Parameters `$cursor` `mixed` - $cursor The optional result set cursor from which to fetch the row. Returns `mixed` - Either the next row from the result set or false if there are no more rows. Since 12.1
`protected mixed`	# `fetchAssoc( mixed $cursor = null )` 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 associative array. Parameters `$cursor` `mixed` - $cursor The optional result set cursor from which to fetch the row. Returns `mixed` - Either the next row from the result set or false if there are no more rows. Since 12.1
`protected mixed`	# `fetchObject( mixed $cursor = null, string $class = 'stdClass' )` Method to fetch a row from the result set cursor as an object. Method to fetch a row from the result set cursor as an object. Parameters `$cursor` `mixed` - $cursor The optional result set cursor from which to fetch the row. `$class` `string` - $class Unused, only necessary so method signature will be the same as parent. Returns `mixed` - Either the next row from the result set or false if there are no more rows. Since 12.1
`protected`	# `freeResult( mixed $cursor = null )` Method to free up the memory used for the result set. Method to free up the memory used for the result set. Parameters `$cursor` `mixed` - $cursor The optional result set cursor from which to fetch the row. Since 12.1
`public mixed`	# `loadNextObject( string $class = 'stdClass' )` 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 object. Deprecated 4.0 (CMS) Use getIterator() instead Parameters `$class` `string` - $class The class name to use for the returned row object. Returns `mixed` - The result of the query as an array, false if there are no more rows. Throws `RuntimeException` Since 12.1 Overrides `FOFDatabaseDriver::loadNextObject`
`public mixed`	# `loadNextAssoc( )` 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 array. Returns `mixed` - The result of the query as an array, false if there are no more rows. Throws `RuntimeException` Since 12.1
`public mixed`	# `loadNextRow( )` 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 array. Deprecated 4.0 (CMS) Use getIterator() instead Returns `mixed` - The result of the query as an array, false if there are no more rows. Throws `RuntimeException` Since 12.1 Overrides `FOFDatabaseDriver::loadNextRow`
`public array`	# `__sleep( )` PDO does not support serialize PDO does not support serialize Returns `array` Since 12.3
`public array`	# `__wakeup( )` Wake up after serialization Wake up after serialization Returns `array` Since 12.3
`protected integer`	# `getErrorNumber( )` Return the actual SQL Error number Return the actual SQL Error number Returns `integer` - The SQL Error number Since 3.4.6
`protected string`	# `getErrorMessage( string $query )` Return the actual SQL Error message Return the actual SQL Error message Parameters `$query` `string` - $query The SQL Query that fails Returns `string` - The SQL Error message Since 3.4.6

Methods inherited from FOFDatabaseDriver

__call(), addDisconnectHandler(), alterDbCharacterSet(), alterTableCharacterSet(), convertUtf8mb4QueryToUtf8(), createDatabase(), dropTable(), getAlterDbCharacterSet(), getAlterTableCharacterSet(), getCallStacks(), getCollation(), getConnection(), getConnectionCollation(), getConnectors(), getCount(), getCreateDatabaseQuery(), getDatabase(), getDateFormat(), getExporter(), getImporter(), getInstance(), getIterator(), getLog(), getMinimum(), getName(), getNullDate(), getPrefix(), getQuery(), getServerType(), getTableColumns(), getTableCreate(), getTableKeys(), getTableList(), getTimings(), getUTFSupport(), getVersion(), hasUTF8mb4Support(), hasUTFSupport(), insertObject(), isMinimumVersion(), loadAssoc(), loadAssocList(), loadColumn(), loadObject(), loadObjectList(), loadResult(), loadRow(), loadRowList(), lockTable(), quote(), quoteName(), quoteNameStr(), renameTable(), replacePrefix(), setDebug(), splitSql(), truncateTable(), unlockTables(), updateObject()

Methods inherited from FOFDatabase

getErrorMsg(), getErrorNum(), query(), stderr(), test()

Magic methods summary

Magic methods inherited from FOFDatabaseDriver

q(), qn()

Properties summary

`public string`	`$name`	# The name of the database driver. The name of the database driver. Since 12.1
`protected PDO`	`$connection`	# The database connection resource. The database connection resource. Since 12.1
`protected string`	`$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. 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 12.1
`protected string`	`$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. 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 12.1
`protected resource`	`$prepared`	# The prepared statement. The prepared statement. Since 12.1
`protected array`	`$executed`	# Contains the current query execution status Contains the current query execution status Since 12.1

Properties inherited from FOFDatabaseDriver

$callStacks, $count, $cursor, $dbMinimum, $debug, $disconnectHandlers, $errorMsg, $errorNum, $instances, $limit, $log, $offset, $options, $serverType, $sql, $tablePrefix, $timings, $transactionDepth, $utf, $utf8mb4

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseDriverPdo

Direct known subclasses

Methods summary

Parameters

Since

Overrides

Since

Returns

Throws

Since

Since

Parameters

Returns

Since

Returns

Throws

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Overrides

Returns

Since

Parameters

Throws

Since

Parameters

Throws

Since

Parameters

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Deprecated

Parameters

Returns

Throws

Since

Overrides

Returns

Throws