Class FOFDatabaseDriverSqlite

SQLite database driver

FOFDatabase

FOFDatabaseDriver implements FOFDatabaseInterface

FOFDatabaseDriverSqlite

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/sqlite.php

Methods summary

`public`	# `__destruct( )` Destructor. Destructor. Since 12.1 Overrides `FOFDatabaseDriverPdo::__destruct`
`public`	# `disconnect( )` Disconnects the database. Disconnects the database. Since 12.1 Overrides `FOFDatabaseDriverPdo::disconnect`
`public FOFDatabaseDriverSqlite`	# `dropTable( string $tableName, boolean $ifExists = true )` Drops a table from the database. Drops a table from the database. Parameters `$tableName` `string` - $tableName The name of the database table to drop. `$ifExists` `boolean` - $ifExists Optionally specify that the table must exist before it is dropped. Returns `FOFDatabaseDriverSqlite` - Returns this object to support chaining. Throws `RuntimeException` Since 12.1
`public string`	# `escape( string $text, boolean $extra = false )` Method to escape a string for usage in an SQLite statement. Method to escape a string for usage in an SQLite statement. 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 Overrides `FOFDatabaseDriverPdo::escape`
`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 12.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` Overrides `FOFDatabaseDriver::getConnectionCollation`
`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. Note: Doesn't appear to have support in SQLite 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 12.1
`public array`	# `getTableColumns( string $table, boolean $typeOnly = true )` Retrieves field information about a given table. Retrieves field information about a given table. Parameters `$table` `string` - $table The name of the database table. `$typeOnly` `boolean` - $typeOnly True to only return field types. Returns `array` - An array of fields for the database table. Throws `RuntimeException` Since 12.1
`public array`	# `getTableKeys( string $table )` Get the details list of keys for a table. Get the details list of keys for a table. Parameters `$table` `string` - $table The name of the table. Returns `array` - An array of the column specification for the table. Throws `RuntimeException` Since 12.1
`public array`	# `getTableList( )` Method to get an array of all tables in the database (schema). Method to get an array of all tables in the database (schema). Returns `array` - An array of all the tables in the database. Throws `RuntimeException` Since 12.1
`public string`	# `getVersion( )` Get the version of the database connector. Get the version of the database connector. Returns `string` - The database connector version. 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 Overrides `FOFDatabaseDriverPdo::select`
`public boolean`	# `setUtf( )` Set the connection to use UTF-8 character encoding. Set the connection to use UTF-8 character encoding. Returns false automatically for the Oracle driver since you can only set the character set when the connection is created. Returns `boolean` - True on success. Since 12.1 Overrides `FOFDatabaseDriverPdo::setUtf`
`public FOFDatabaseDriverSqlite`	# `lockTable( string $table )` Locks a table in the database. Locks a table in the database. Parameters `$table` `string` - $table The name of the table to unlock. Returns `FOFDatabaseDriverSqlite` - Returns this object to support chaining. Throws `RuntimeException` Since 12.1
`public FOFDatabaseDriverSqlite`	# `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 Not used by Sqlite. `$prefix` `string` - $prefix Not used by Sqlite. Returns `FOFDatabaseDriverSqlite` - Returns this object to support chaining. Throws `RuntimeException` Since 12.1
`public FOFDatabaseDriverSqlite`	# `unlockTables( )` Unlocks tables in the database. Unlocks tables in the database. Returns `FOFDatabaseDriverSqlite` - Returns this object to support chaining. Throws `RuntimeException` Since 12.1
`public static boolean`	# `isSupported( )` Test to see if the PDO ODBC connector is available. Test to see if the PDO ODBC connector is available. Returns `boolean` - True on success, false otherwise. Since 12.1 Overrides `FOFDatabaseDriverPdo::isSupported`
`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.3 Overrides `FOFDatabaseDriverPdo::transactionCommit`
`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.3 Overrides `FOFDatabaseDriverPdo::transactionRollback`
`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.3 Overrides `FOFDatabaseDriverPdo::transactionStart`

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
`public string`	`$serverType`	# The type of the database server family supported by this driver. The type of the database server family supported by this driver. Since CMS 3.5.0
`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

Properties inherited from FOFDatabaseDriverPdo

$connection, $executed, $nullDate, $prepared

Properties inherited from FOFDatabaseDriver

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

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseDriverSqlite

Methods summary

Since

Overrides

Since

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Overrides

Returns

Since

Returns

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Returns

Throws

Since

Returns

Since

Parameters

Returns

Throws

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Returns

Throws

Since

Returns

Since

Overrides

Parameters

Throws

Since

Overrides

Parameters

Throws

Since

Overrides

Parameters

Throws

Since

Overrides

Methods inherited from FOFDatabaseDriverPdo

Methods inherited from FOFDatabaseDriver

Methods inherited from FOFDatabase

Magic methods summary

Magic methods inherited from FOFDatabaseDriver