Class FOFDatabaseDriverJoomla

Joomla! pass-through database driver.

FOFDatabase

FOFDatabaseDriverJoomla implements FOFDatabaseInterface

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
Located at fof/database/driver/joomla.php

Methods summary

`public static`	# `isSupported( )` Is this driver supported Is this driver supported Since 11.2
`public`	# `__construct( array $options = array() )` Database object constructor Database object constructor Parameters `$options` `array` - $options List of options used to configure the connection
`public`	# `close( )`
`public`	# `disconnect( )`
`public`	# `open( )`
`public`	# `connect( )`
`public`	# `connected( )`
`public`	# `escape( mixed $text, mixed $extra = false )`
`public`	# `execute( )`
`public`	# `getAffectedRows( )`
`public`	# `getCollation( )`
`public`	# `getConnection( )`
`public`	# `getCount( )`
`public`	# `getDateFormat( )`
`public`	# `getMinimum( )`
`public`	# `getNullDate( )`
`public`	# `getNumRows( mixed $cursor = null )`
`public`	# `getQuery( mixed $new = false )`
`public`	# `getTableColumns( mixed $table, mixed $typeOnly = true )`
`public`	# `getTableKeys( mixed $tables )`
`public`	# `getTableList( )`
`public`	# `getVersion( )`
`public`	# `insertid( )`
`public`	# `insertObject( mixed $table, mixed & $object, mixed $key = null )`
`public`	# `loadAssoc( )`
`public`	# `loadAssocList( mixed $key = null, mixed $column = null )`
`public`	# `loadObject( mixed $class = 'stdClass' )`
`public`	# `loadObjectList( mixed $key = '', mixed $class = 'stdClass' )`
`public`	# `loadResult( )`
`public`	# `loadRow( )`
`public`	# `loadRowList( mixed $key = null )`
`public`	# `lockTable( mixed $tableName )`
`public`	# `quote( mixed $text, mixed $escape = true )`
`public`	# `select( mixed $database )`
`public`	# `setQuery( mixed $query, mixed $offset = 0, mixed $limit = 0 )`
`public`	# `transactionCommit( mixed $toSavepoint = false )`
`public`	# `transactionRollback( mixed $toSavepoint = false )`
`public`	# `transactionStart( mixed $asSavepoint = false )`
`public`	# `unlockTables( )`
`public`	# `updateObject( mixed $table, mixed & $object, mixed $key, mixed $nulls = false )`
`public`	# `getLog( )`
`public`	# `dropTable( mixed $table, mixed $ifExists = true )`
`public`	# `getTableCreate( mixed $tables )`
`public`	# `renameTable( mixed $oldTable, mixed $newTable, mixed $backup = null, mixed $prefix = null )`
`public`	# `setUtf( )`
`protected`	# `freeResult( mixed $cursor = null )`
`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`	# `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`	# `getErrorMsg( boolean $escaped = false )` Gets the error message from the database connection. Gets the error message from the database connection. Parameters `$escaped` `boolean` - $escaped True to escape the message string for use in JavaScript. Returns `string` - The error message for the most recent query. Since 11.1 Overrides `FOFDatabase::getErrorMsg`
`public integer`	# `getErrorNum( )` Gets the error number from the database connection. Gets the error number from the database connection. Deprecated 13.3 (Platform) & 4.0 (CMS) Returns `integer` - The error number for the most recent query. Since 11.1 Overrides `FOFDatabase::getErrorNum`
`public string`	# `stderr( boolean $showSQL = false )` Return the most recent error message for the database connector. Return the most recent error message for the database connector. Parameters `$showSQL` `boolean` - $showSQL True to display the SQL statement sent to the database as well as the error. Returns `string` - The error message for the most recent query. Overrides `FOFDatabase::stderr`
`public`	# `__call( mixed $name, array $arguments )` Magic method to proxy all calls to the loaded database driver object Magic method to proxy all calls to the loaded database driver object
`public`	# `__get( mixed $name )`
`public`	# `__set( mixed $name, mixed $value )`

Methods inherited from FOFDatabase

getConnectors(), getInstance(), query(), splitSql(), test()

Magic methods summary

Properties summary

`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

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseDriverJoomla

Methods summary

Since

Parameters

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Deprecated

Returns

Since

Overrides

Parameters

Returns

Overrides

Methods inherited from FOFDatabase

Magic methods summary

Properties summary

Since