Class FOFDatabaseDriverPdomysql

MySQL database driver supporting PDO based connections

FOFDatabase

Extended by

FOFDatabaseDriver implements FOFDatabaseInterface

Extended by

FOFDatabaseDriverPdo

Extended by

FOFDatabaseDriverPdomysql

Package: Joomla\Platform\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: 3.4
See: http://php.net/manual/en/ref.pdo-mysql.php
Located at fof/database/driver/pdomysql.php

Methods summary

`public`	# `__construct( array $options )` Constructor. Constructor. Parameters `$options` `array` - $options Array of database options with keys: host, user, password, database, select. Since 3.4 Overrides `FOFDatabaseDriverPdo::__construct`
`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 3.4 Overrides `FOFDatabaseDriverPdo::connect`
`public static boolean`	# `isSupported( )` Test to see if the MySQL connector is available. Test to see if the MySQL connector is available. Returns `boolean` - True on success, false otherwise. Since 3.4 Overrides `FOFDatabaseDriverPdo::isSupported`
`public FOFDatabaseDriverPdomysql`	# `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 `FOFDatabaseDriverPdomysql` - Returns this object to support chaining. Throws `RuntimeException` Since 3.4
`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 3.4 Overrides `FOFDatabaseDriverPdo::select`
`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 (string) or boolean false if not supported. Throws `RuntimeException` Since 3.4
`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. 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 3.4
`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 3.4
`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 3.4
`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 3.4
`public string`	# `getVersion( )` Get the version of the database connector. Get the version of the database connector. Returns `string` - The database connector version. Since 3.4
`public FOFDatabaseDriverPdomysql`	# `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 `FOFDatabaseDriverPdomysql` - Returns this object to support chaining. Throws `RuntimeException` Since 3.4
`public FOFDatabaseDriverPdomysql`	# `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 MySQL. `$prefix` `string` - $prefix Not used by MySQL. Returns `FOFDatabaseDriverPdomysql` - Returns this object to support chaining. Throws `RuntimeException` Since 3.4
`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 3.4 Overrides `FOFDatabaseDriverPdo::escape`
`public FOFDatabaseDriverPdomysql`	# `unlockTables( )` Unlocks tables in the database. Unlocks tables in the database. Returns `FOFDatabaseDriverPdomysql` - Returns this object to support chaining. Throws `RuntimeException` Since 3.4
`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 3.4 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 3.4 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 3.4 Overrides `FOFDatabaseDriverPdo::transactionStart`

Methods inherited from FOFDatabaseDriverPdo

__destruct(), __sleep(), __wakeup(), connected(), disconnect(), execute(), fetchArray(), fetchAssoc(), fetchObject(), freeResult(), getAffectedRows(), getConnectedQuery(), getErrorMessage(), getErrorNumber(), getNumRows(), getOption(), insertid(), loadNextAssoc(), loadNextObject(), loadNextRow(), setOption(), setQuery(), setUtf()

Methods inherited from FOFDatabaseDriver

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

Methods inherited from FOFDatabase

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

Magic methods summary

Magic methods inherited from FOFDatabaseDriver

Properties summary

`public string`	`$name`	# The name of the database driver. The name of the database driver. Since 3.4
`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 3.4
`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 3.4
`protected static string`	`$dbMinimum`	# The minimum supported database version. The minimum supported database version. Since 3.4

Properties inherited from FOFDatabaseDriverPdo

$connection, $executed, $prepared

Properties inherited from FOFDatabaseDriver

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