Class FOFDatabaseDriver

Joomla Platform Database Driver Class

FOFDatabase

FOFDatabaseDriver implements FOFDatabaseInterface

Direct known subclasses

FOFDatabaseDriverMysqli, FOFDatabaseDriverPdo, FOFDatabaseDriverPostgresql, FOFDatabaseDriverSqlsrv

Indirect known subclasses

FOFDatabaseDriverMysql, FOFDatabaseDriverOracle, FOFDatabaseDriverPdomysql, FOFDatabaseDriverSqlazure, 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
Located at fof/database/driver.php

Methods summary

`public static array`	# `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. 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. Returns `array` - An array of available database connectors. Since 11.1 Overrides `FOFDatabase::getConnectors`
`public static FOFDatabaseDriver`	# `getInstance( array $options = array() )` Method to return a FOFDatabaseDriver 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 FOFDatabaseDriver 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. Method to return a FOFDatabaseDriver 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 FOFDatabaseDriver 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. Parameters `$options` `array` - $options Parameters to be passed to the database driver. Returns `FOFDatabaseDriver` - A database object. Throws `RuntimeException` Since 11.1 Overrides `FOFDatabase::getInstance`
`public static array`	# `splitSql( string $sql )` Splits a string of multiple queries into an array of individual queries. Splits a string of multiple queries into an array of individual queries. Parameters `$sql` `string` - $sql Input SQL string with which to split into individual queries. Returns `array` - The queries from the input string separated into an array. Since 11.1 Overrides `FOFDatabase::splitSql`
`public mixed`	# `__call( string $method, array $args )` Magic method to provide method alias support for quote() and quoteName(). Magic method to provide method alias support for quote() and quoteName(). Parameters `$method` `string` - $method The called method. `$args` `array` - $args The array of arguments passed to the method. Returns `mixed` - The aliased method's return value or null. Since 11.1
`public`	# `__construct( array $options )` Constructor. Constructor. Parameters `$options` `array` - $options List of options used to configure the connection Since 11.1
`public string`	# `alterDbCharacterSet( string $dbName )` Alter database's character set, obtaining query string from protected member. Alter database's character set, obtaining query string from protected member. Parameters `$dbName` `string` - $dbName The database name that will be altered Returns `string` - The query that alter the database query string Throws `RuntimeException` Since 12.2
`public boolean`	# `alterTableCharacterSet( string $tableName, boolean $rethrow = false )` Alter a table's character set, obtaining an array of queries to do so from a protected method. The conversion is wrapped in a transaction, if supported by the database driver. Otherwise the table will be locked before the conversion. This prevents data corruption. Alter a table's character set, obtaining an array of queries to do so from a protected method. The conversion is wrapped in a transaction, if supported by the database driver. Otherwise the table will be locked before the conversion. This prevents data corruption. Parameters `$tableName` `string` - $tableName The name of the table to alter `$rethrow` `boolean` - $rethrow True to rethrow database exceptions. Default: false (exceptions are suppressed) Returns `boolean` - True if successful Throws `RuntimeException` - If the table name is empty `Exception` - Relayed from the database layer if a database error occurs and $rethrow == true Since CMS 3.5.0
`abstract 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
`abstract 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 11.1
`public string`	# `createDatabase( stdClass $options, boolean $utf = true )` Create a new database using information from $options object, obtaining query string from protected member. Create a new database using information from $options object, obtaining query string from protected member. Parameters `$options` `stdClass` - $options Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set. `$utf` `boolean` - $utf True if the database supports the UTF-8 character set. Returns `string` - The query that creates database Throws `RuntimeException` Since 12.2
`abstract public`	# `disconnect( )` Disconnects the database. Disconnects the database. Since 12.1
`public`	# `addDisconnectHandler( callable $callable )` Adds a function callable just before disconnecting the database. Parameter of the callable is $this FOFDatabaseDriver Adds a function callable just before disconnecting the database. Parameter of the callable is $this FOFDatabaseDriver Parameters `$callable` `callable` - $callable Function to call in disconnect() method just before disconnecting from database Since CMS 3.1.2
`abstract public FOFDatabaseDriver`	# `dropTable( string $table, boolean $ifExists = true )` Drops a table from the database. Drops a table from the database. Parameters `$table` `string` - $table The name of the database table to drop. `$ifExists` `boolean` - $ifExists Optionally specify that the table must exist before it is dropped. Returns `FOFDatabaseDriver` - Returns this object to support chaining. Throws `RuntimeException` Since 11.4
`abstract public string`	# `escape( string $text, boolean $extra = false )` Escapes a string for usage in an SQL statement. Escapes a string for usage in an SQL statement. Parameters `$text` `string` - $text The string to be escaped. `$extra` `boolean` - $extra Optional parameter to provide extra escaping. Returns `string` - The escaped string. Since 11.1
`abstract 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 11.1
`abstract 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 11.1
`abstract 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 The class name to use for the returned row object. Returns `mixed` - Either the next row from the result set or false if there are no more rows. Since 11.1
`abstract 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 11.1
`abstract public integer`	# `getAffectedRows( )` Get the number of affected rows for the previous executed SQL statement. Get the number of affected rows for the previous executed SQL statement. Returns `integer` - The number of affected rows. Since 11.1
`public string`	# `getAlterDbCharacterSet( string $dbName )` Return the query string to alter the database character set. Return the query string to alter the database character set. Parameters `$dbName` `string` - $dbName The database name Returns `string` - The query that alter the database query string Since 12.2
`public string[]`	# `getAlterTableCharacterSet( string $tableName )` Get the query strings to alter the character set and collation of a table. Get the query strings to alter the character set and collation of a table. Parameters `$tableName` `string` - $tableName The name of the table Returns `string[]` - The queries required to alter the table's character set and collation Since CMS 3.5.0
`public string`	# `convertUtf8mb4QueryToUtf8( string $query )` Automatically downgrade a CREATE TABLE or ALTER TABLE query from utf8mb4 (UTF-8 Multibyte) to plain utf8. Used when the server doesn't support UTF-8 Multibyte. Automatically downgrade a CREATE TABLE or ALTER TABLE query from utf8mb4 (UTF-8 Multibyte) to plain utf8. Used when the server doesn't support UTF-8 Multibyte. Parameters `$query` `string` - $query The query to convert Returns `string` - The converted query
`protected string`	# `getCreateDatabaseQuery( stdClass $options, boolean $utf )` 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 string to create new Database. Each database driver, other than MySQL, need to override this member to return correct string. Parameters `$options` `stdClass` - $options Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set. `$utf` `boolean` - $utf True if the database supports the UTF-8 character set. Returns `string` - The query that creates database Since 12.2
`abstract public mixed`	# `getCollation( )` Method to get the database collation in use by sampling a text field of a table in the database. Method to get the database collation in use by sampling a text field of a table in the database. Returns `mixed` - The collation in use by the database or boolean false if not supported. Since 11.1
`public string`	# `getConnectionCollation( )` Method to get the database connection collation, as reported by the driver. If the connector doesn't support reporting this value please return an empty string. Method to get the database connection collation, as reported by the driver. If the connector doesn't support reporting this value please return an empty string. Returns `string`
`public resource`	# `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. 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. Returns `resource` - The underlying database connection resource. Since 11.1
`public integer`	# `getCount( )` Get the total number of SQL statements executed by the database driver. Get the total number of SQL statements executed by the database driver. Returns `integer` Since 11.1
`protected string`	# `getDatabase( )` Gets the name of the database used by this conneciton. Gets the name of the database used by this conneciton. Returns `string` Since 11.4
`public string`	# `getDateFormat( )` Returns a PHP date() function compliant date format for the database driver. Returns a PHP date() function compliant date format for the database driver. Returns `string` - The format string. Since 11.1
`public array`	# `getLog( )` Get the database driver SQL statement log. Get the database driver SQL statement log. Returns `array` - SQL statements executed by the database driver. Since 11.1
`public array`	# `getTimings( )` Get the database driver SQL statement log. Get the database driver SQL statement log. Returns `array` - SQL statements executed by the database driver. Since CMS 3.1.2
`public array`	# `getCallStacks( )` Get the database driver SQL statement log. Get the database driver SQL statement log. Returns `array` - SQL statements executed by the database driver. Since CMS 3.1.2
`public string`	# `getMinimum( )` Get the minimum supported database version. Get the minimum supported database version. Returns `string` - The minimum version number for the database driver. Since 12.1
`public string`	# `getNullDate( )` Get the null or zero representation of a timestamp for the database driver. Get the null or zero representation of a timestamp for the database driver. Returns `string` - Null or zero representation of a timestamp. Since 11.1
`abstract public integer`	# `getNumRows( resource $cursor = null )` Get the number of returned rows for the previous executed SQL statement. Get the number of returned rows for the previous executed SQL statement. Parameters `$cursor` `resource` - $cursor An optional database cursor resource to extract the row count from. Returns `integer` - The number of returned rows. Since 11.1
`public string`	# `getPrefix( )` Get the common table prefix for the database driver. Get the common table prefix for the database driver. Returns `string` - The common database table prefix. Since 11.1
`public FOFDatabaseExporter`	# `getExporter( )` Gets an exporter class object. Gets an exporter class object. Returns `FOFDatabaseExporter` - An exporter object. Throws `RuntimeException` Since 12.1
`public FOFDatabaseImporter`	# `getImporter( )` Gets an importer class object. Gets an importer class object. Returns `FOFDatabaseImporter` - An importer object. Throws `RuntimeException` Since 12.1
`public string`	# `getName( )` Get the name of the database driver. If $this->name is not set it will try guessing the driver name from the class name. Get the name of the database driver. If $this->name is not set it will try guessing the driver name from the class name. Returns `string` Since CMS 3.5.0
`public string`	# `getServerType( )` Get the server family type, e.g. mysql, postgresql, oracle, sqlite, mssql. If $this->serverType is not set it will attempt guessing the server family type from the driver name. If this is not possible the driver name will be returned instead. Get the server family type, e.g. mysql, postgresql, oracle, sqlite, mssql. If $this->serverType is not set it will attempt guessing the server family type from the driver name. If this is not possible the driver name will be returned instead. Returns `string` Since CMS 3.5.0
`public FOFDatabaseQuery`	# `getQuery( boolean $new = false )` Get the current query object or a new FOFDatabaseQuery object. Get the current query object or a new FOFDatabaseQuery object. Parameters `$new` `boolean` - $new False to return the current query object, True to return a new FOFDatabaseQuery object. Returns `FOFDatabaseQuery` - The current query object or a new object extending the FOFDatabaseQuery class. Throws `RuntimeException` Since 11.1
`public FOFDatabaseIterator`	# `getIterator( string $column = null, string $class = 'stdClass' )` Get a new iterator on the current query. Get a new iterator on the current query. Parameters `$column` `string` - $column An option column to use as the iterator key. `$class` `string` - $class The class of object that is returned. Returns `FOFDatabaseIterator` - A new database iterator. Throws `RuntimeException` Since 12.1
`abstract public array`	# `getTableColumns( string $table, boolean $typeOnly = true )` Retrieves field information about the given tables. Retrieves field information about the given tables. Parameters `$table` `string` - $table The name of the database table. `$typeOnly` `boolean` - $typeOnly True (default) to only return field types. Returns `array` - An array of fields by table. Throws `RuntimeException` Since 11.1
`abstract public array`	# `getTableCreate( mixed $tables )` Shows the table CREATE statement that creates the given tables. Shows the table CREATE statement that creates the given tables. Parameters `$tables` `mixed` - $tables A table name or a list of table names. Returns `array` - A list of the create SQL for the tables. Throws `RuntimeException` Since 11.1
`abstract public array`	# `getTableKeys( mixed $tables )` Retrieves field information about the given tables. Retrieves field information about the given tables. Parameters `$tables` `mixed` - $tables A table name or a list of table names. Returns `array` - An array of keys for the table(s). Throws `RuntimeException` Since 11.1
`abstract public array`	# `getTableList( )` Method to get an array of all tables in the database. Method to get an array of all tables in the database. Returns `array` - An array of all the tables in the database. Throws `RuntimeException` Since 11.1
`public boolean`	# `getUTFSupport( )` Determine whether or not the database engine supports UTF-8 character encoding. Determine whether or not the database engine supports UTF-8 character encoding. Deprecated 12.3 (Platform) & 4.0 (CMS) - Use hasUTFSupport() instead Returns `boolean` - True if the database engine supports UTF-8 character encoding. Since 11.1
`public boolean`	# `hasUTFSupport( )` Determine whether or not the database engine supports UTF-8 character encoding. Determine whether or not the database engine supports UTF-8 character encoding. Returns `boolean` - True if the database engine supports UTF-8 character encoding. Since 12.1
`public boolean`	# `hasUTF8mb4Support( )` Determine whether the database engine support the UTF-8 Multibyte (utf8mb4) character encoding. This applies to MySQL databases. Determine whether the database engine support the UTF-8 Multibyte (utf8mb4) character encoding. This applies to MySQL databases. Returns `boolean` - True if the database engine supports UTF-8 Multibyte. Since CMS 3.5.0
`abstract public string`	# `getVersion( )` Get the version of the database connector Get the version of the database connector Returns `string` - The database connector version. Since 11.1
`abstract public mixed`	# `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 `mixed` - The value of the auto-increment field from the last inserted row. Since 11.1
`public boolean`	# `insertObject( string $table, object & $object, string $key = null )` Inserts a row into a table based on an object's properties. Inserts a row into a table based on an object's properties. Parameters `$table` `string` - $table The name of the database table to insert into. `$object` `object` - &$object A reference to an object whose public properties match the table fields. `$key` `string` - $key The name of the primary key. If provided the object property is updated. Returns `boolean` - True on success. Throws `RuntimeException` Since 11.1
`public boolean`	# `isMinimumVersion( )` Method to check whether the installed database version is supported by the database driver Method to check whether the installed database version is supported by the database driver Returns `boolean` - True if the database version is supported Since 12.1
`public mixed`	# `loadAssoc( )` Method to get the first row of the result set from the database query as an associative array of ['field_name' => 'row_value']. Method to get the first row of the result set from the database query as an associative array of ['field_name' => 'row_value']. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`public mixed`	# `loadAssocList( string $key = null, string $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. 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. Parameters `$key` `string` - $key The name of a field on which to key the result array. `$column` `string` - $column An optional column name. Instead of the whole row, only this column value will be in the result array. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`public mixed`	# `loadColumn( integer $offset = 0 )` Method to get an array of values from the `$offset` field in each row of the result set from the database query. Method to get an array of values from the `$offset` field in each row of the result set from the database query. Parameters `$offset` `integer` - $offset The row offset to use to build the result array. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.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 12.3 (Platform) & 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 11.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 FOFDatabaseDriver::getIterator() instead Returns `mixed` - The result of the query as an array, false if there are no more rows. Throws `RuntimeException` Since 11.1
`public mixed`	# `loadObject( string $class = 'stdClass' )` Method to get the first row of the result set from the database query as an object. Method to get the first row of the result set from the database query as an object. Parameters `$class` `string` - $class The class name to use for the returned row object. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`public mixed`	# `loadObjectList( string $key = '', string $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. 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. Parameters `$key` `string` - $key The name of a field on which to key the result array. `$class` `string` - $class The class name to use for the returned row objects. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`public mixed`	# `loadResult( )` Method to get the first field of the first row of the result set from the database query. Method to get the first field of the first row of the result set from the database query. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`public mixed`	# `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. 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. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`public mixed`	# `loadRowList( string $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. 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. Parameters `$key` `string` - $key The name of a field on which to key the result array. Returns `mixed` - The return value or null if the query failed. Throws `RuntimeException` Since 11.1
`abstract public FOFDatabaseDriver`	# `lockTable( string $tableName )` Locks a table in the database. Locks a table in the database. Parameters `$tableName` `string` - $tableName The name of the table to unlock. Returns `FOFDatabaseDriver` - Returns this object to support chaining. Throws `RuntimeException` Since 11.4
`public string`	# `quote( mixed $text, boolean $escape = true )` Quotes and optionally escapes a string to database requirements for use in database queries. Quotes and optionally escapes a string to database requirements for use in database queries. Parameters `$text` `mixed` - $text A string or an array of strings to quote. `$escape` `boolean` - $escape True (default) to escape the string, false to leave it unchanged. Returns `string` - The quoted input string. Since 11.1 Note Accepting an array of strings was added in 12.3.
`public mixed`	# `quoteName( mixed $name, mixed $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. Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts. Parameters `$name` `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. `$as` `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. Returns `mixed` - The quote wrapped name, same type of $name. Since 11.1
`protected string`	# `quoteNameStr( array $strArr )` Quote strings coming from quoteName call. Quote strings coming from quoteName call. Parameters `$strArr` `array` - $strArr Array of strings coming from quoteName dot-explosion. Returns `string` - Dot-imploded string of quoted parts. Since 11.3
`public string`	# `replacePrefix( string $sql, string $prefix = '#__' )` This function replaces a string identifier `$prefix` with the string held is the `tablePrefix` class variable. This function replaces a string identifier `$prefix` with the string held is the `tablePrefix` class variable. Parameters `$sql` `string` - $sql The SQL statement to prepare. `$prefix` `string` - $prefix The common table prefix. Returns `string` - The processed SQL statement. Since 11.1
`abstract public FOFDatabaseDriver`	# `renameTable( string $oldTable, string $newTable, string $backup = null, string $prefix = null )` Renames a table in the database. Renames a table in the database. Parameters `$oldTable` `string` - $oldTable The name of the table to be renamed `$newTable` `string` - $newTable The new name for the table. `$backup` `string` - $backup Table prefix `$prefix` `string` - $prefix For the table - used to rename constraints in non-mysql databases Returns `FOFDatabaseDriver` - Returns this object to support chaining. Throws `RuntimeException` Since 11.4
`abstract 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 11.1
`public boolean`	# `setDebug( boolean $level )` Sets the database debugging state for the driver. Sets the database debugging state for the driver. Parameters `$level` `boolean` - $level True to enable debugging. Returns `boolean` - The old debugging level. Since 11.1
`public FOFDatabaseDriver`	# `setQuery( mixed $query, integer $offset = 0, integer $limit = 0 )` 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. Returns `FOFDatabaseDriver` - This object to support method chaining. Since 11.1
`abstract 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 11.1
`abstract 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 11.1
`abstract 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 11.1
`abstract 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 11.1
`public`	# `truncateTable( string $table )` Method to truncate a table. Method to truncate a table. Parameters `$table` `string` - $table The table to truncate Throws `RuntimeException` Since 11.3
`public boolean`	# `updateObject( string $table, object & $object, array $key, boolean $nulls = false )` Updates a row in a table based on an object's properties. Updates a row in a table based on an object's properties. Parameters `$table` `string` - $table The name of the database table to update. `$object` `object` - &$object A reference to an object whose public properties match the table fields. `$key` `array` - $key The name of the primary key. `$nulls` `boolean` - $nulls True to update null fields or false to ignore them. Returns `boolean` - True on success. Throws `RuntimeException` Since 11.1
`abstract 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` Since 12.1
`abstract public FOFDatabaseDriver`	# `unlockTables( )` Unlocks tables in the database. Unlocks tables in the database. Returns `FOFDatabaseDriver` - Returns this object to support chaining. Throws `RuntimeException` Since 11.4

Methods inherited from FOFDatabase

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

Magic methods summary

`public string`	# `q( mixed $escape = true )` Alias for quote method Alias for quote method Parameters `$escape` Returns `string`
`public string`	# `qn( mixed $as = null )` Alias for quoteName method Alias for quoteName method Parameters `$as` Returns `string`

Properties summary

`public string`	`$name`	# The name of the database driver. The name of the database driver. Since 11.1
`public string`	`$serverType`	# The type of the database server family supported by this driver. Examples: mysql, oracle, postgresql, mssql, sqlite. The type of the database server family supported by this driver. Examples: mysql, oracle, postgresql, mssql, sqlite. Since CMS 3.5.0
`protected resource`	`$connection`	# The database connection resource. The database connection resource. Since 11.1
`protected integer`	`$count`	# The number of SQL statements executed by the database driver. The number of SQL statements executed by the database driver. Since 11.1
`protected resource`	`$cursor`	# The database connection cursor from the last query. The database connection cursor from the last query. Since 11.1
`protected boolean`	`$debug`	# The database driver debugging state. The database driver debugging state. Since 11.1
`protected integer`	`$limit`	# The affected row limit for the current SQL statement. The affected row limit for the current SQL statement. Since 11.1
`protected array`	`$log`	# The log of executed SQL statements by the database driver. The log of executed SQL statements by the database driver. Since 11.1
`protected array`	`$timings`	# The log of executed SQL statements timings (start and stop microtimes) by the database driver. The log of executed SQL statements timings (start and stop microtimes) by the database driver. Since CMS 3.1.2
`protected array`	`$callStacks`	# The log of executed SQL statements timings (start and stop microtimes) by the database driver. The log of executed SQL statements timings (start and stop microtimes) by the database driver. Since CMS 3.1.2
`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 11.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 11.1
`protected integer`	`$offset`	# The affected row offset to apply for the current SQL statement. The affected row offset to apply for the current SQL statement. Since 11.1
`protected array`	`$options`	# Passed in upon instantiation and saved. Passed in upon instantiation and saved. Since 11.1
`protected mixed`	`$sql`	# The current SQL statement to execute. The current SQL statement to execute. Since 11.1
`protected string`	`$tablePrefix`	# The common database table prefix. The common database table prefix. Since 11.1
`protected boolean`	`$utf`	# True if the database engine supports UTF-8 character encoding. True if the database engine supports UTF-8 character encoding. Since 11.1
`protected boolean`	`$utf8mb4`	# True if the database engine supports UTF-8 Multibyte (utf8mb4) character encoding. True if the database engine supports UTF-8 Multibyte (utf8mb4) character encoding. Since CMS 3.5.0
`protected integer`	`$errorNum`	# The database error number The database error number Deprecated 12.1 Since 11.1
`protected string`	`$errorMsg`	# The database error message The database error message Deprecated 12.1 Since 11.1
`protected static array`	`$instances`	# FOFDatabaseDriver instances container. FOFDatabaseDriver instances container. Since 11.1
`protected static string`	`$dbMinimum`	# The minimum supported database version. The minimum supported database version. Since 12.1
`protected integer`	`$transactionDepth`	# The depth of the current transaction. The depth of the current transaction. Since 12.3
`protected callable[]`	`$disconnectHandlers`	# List of callables to call just before disconnecting database List of callables to call just before disconnecting database Since CMS 3.1.2

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseDriver

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Returns

Throws

Since

Returns

Since

Parameters

Returns

Throws

Since

Since

Parameters

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Parameters

Returns

Since

Returns

Since