Class FOFDatabaseDriverMysql

MySQL database driver

FOFDatabase

FOFDatabaseDriver implements FOFDatabaseInterface

FOFDatabaseDriverMysql

Package: FrameworkOnFramework\database
Deprecated: Will be removed when the minimum supported PHP version no longer includes the deprecated PHP mysql extension
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://dev.mysql.com/doc/
Located at fof/database/driver/mysql.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 12.1 Overrides `FOFDatabaseDriverMysqli::__construct`
`public`	# `__destruct( )` Destructor. Destructor. Since 12.1 Overrides `FOFDatabaseDriverMysqli::__destruct`
`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 Overrides `FOFDatabaseDriverMysqli::connect`
`public`	# `disconnect( )` Disconnects the database. Disconnects the database. Since 12.1 Overrides `FOFDatabaseDriverMysqli::disconnect`
`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. Parameters `$text` `string` - $text The string to be escaped. `$extra` `boolean` - $extra Optional parameter to provide extra escaping. Returns `string` - The escaped string. Since 12.1 Overrides `FOFDatabaseDriverMysqli::escape`
`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 12.1 Overrides `FOFDatabaseDriverMysqli::isSupported`
`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 Overrides `FOFDatabaseDriverMysqli::connected`
`public integer`	# `getAffectedRows( )` Get the number of affected rows by the last INSERT, UPDATE, REPLACE or DELETE for the previous executed SQL statement. Get the number of affected rows by the last INSERT, UPDATE, REPLACE or DELETE for the previous executed SQL statement. Returns `integer` - The number of affected rows. Since 12.1 Overrides `FOFDatabaseDriverMysqli::getAffectedRows`
`public integer`	# `getNumRows( resource $cursor = null )` Get the number of returned rows for the previous executed SQL statement. This command is only valid for statements like SELECT or SHOW that return an actual result set. To retrieve the number of rows affected by a INSERT, UPDATE, REPLACE or DELETE query, use getAffectedRows(). Get the number of returned rows for the previous executed SQL statement. This command is only valid for statements like SELECT or SHOW that return an actual result set. To retrieve the number of rows affected by a INSERT, UPDATE, REPLACE or DELETE query, use getAffectedRows(). 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 Overrides `FOFDatabaseDriverMysqli::getNumRows`
`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 Overrides `FOFDatabaseDriverMysqli::getVersion`
`public integer`	# `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 `integer` - The value of the auto-increment field from the last inserted row. Since 12.1 Overrides `FOFDatabaseDriverMysqli::insertid`
`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 Overrides `FOFDatabaseDriverMysqli::execute`
`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 `FOFDatabaseDriverMysqli::select`
`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 Overrides `FOFDatabaseDriverMysqli::setUtf`
`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 Overrides `FOFDatabaseDriverMysqli::fetchArray`
`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 Overrides `FOFDatabaseDriverMysqli::fetchAssoc`
`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 12.1 Overrides `FOFDatabaseDriverMysqli::fetchObject`
`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 Overrides `FOFDatabaseDriverMysqli::freeResult`
`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 Overrides `FOFDatabaseDriverMysqli::getErrorNumber`
`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 Overrides `FOFDatabaseDriverMysqli::getErrorMessage`

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

Properties inherited from FOFDatabaseDriverMysqli

$connection, $dbMinimum, $nameQuote, $nullDate, $serverType

Properties inherited from FOFDatabaseDriver

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

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseDriverMysql

Methods summary

Parameters

Since

Overrides

Since

Overrides

Returns

Throws

Since

Overrides

Since

Overrides

Parameters

Returns

Since

Overrides

Returns

Since

Overrides

Returns

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Returns

Since

Overrides

Returns

Since

Overrides

Returns

Throws

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Since

Overrides

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Methods inherited from FOFDatabaseDriverMysqli

Methods inherited from FOFDatabaseDriver

Methods inherited from FOFDatabase

Magic methods summary