TYPO3\CMS\Dbal\Database\DatabaseConnection Class Reference

Inheritance diagram for TYPO3\CMS\Dbal\Database\DatabaseConnection:

Public Member Functions
	__construct ()
	initialize ()
	getSpecifics ()
	clearCachedFieldInfo ()
	cacheFieldInfo ()
	exec_INSERTquery ($table, $fields_values, $no_quote_fields=false)
	exec_INSERTmultipleRows ($table, array $fields, array $rows, $no_quote_fields=false)
	exec_UPDATEquery ($table, $where, $fields_values, $no_quote_fields=false)
	exec_DELETEquery ($table, $where)
	exec_SELECTquery ($select_fields, $from_table, $where_clause, $groupBy='', $orderBy='', $limit='')
	exec_TRUNCATEquery ($table)
	INSERTquery ($table, $fields_values, $no_quote_fields=false)
	INSERTmultipleRows ($table, array $fields, array $rows, $no_quote_fields=false)
	UPDATEquery ($table, $where, $fields_values, $no_quote_fields=false)
	DELETEquery ($table, $where)
	SELECTquery ($select_fields, $from_table, $where_clause, $groupBy='', $orderBy='', $limit='')
	TRUNCATEquery ($table)
	prepare_SELECTquery ($select_fields, $from_table, $where_clause, $groupBy='', $orderBy='', $limit='', array $input_parameters=[])
	quoteFieldNames ($select_fields)
	quoteFromTables ($from_table)
	quoteWhereClause ($where_clause)
	fullQuoteStr ($str, $table, $allowNull=false)
	quoteStr ($str, $table)
	quoteName ($name, $handlerKey=null, $useBackticks=false)
	MetaType ($type, $table, $maxLength=-1)
	getMetadata ($type, $table, $field, $maxLength=-1)
	MySQLMetaType ($t)
	MySQLActualType ($meta)
	getEquivalentIndexDefinition ($indexSQL)
	getEquivalentFieldDefinition ($fieldSQL)
	sql_error ()
	sql_errno ()
	sql_num_rows ($res)
	sql_fetch_assoc ($res)
	sql_fetch_row ($res)
	sql_free_result ($res)
	sql_insert_id ()
	sql_affected_rows ()
	sql_data_seek ($res, $seek)
	sql_field_metatype ($table, $field)
	sql_field_type ($res, $pointer)
	sql_query ($query)
	sql_pconnect ()
	sql_select_db ()
	admin_get_tables ()
	admin_query ($query)
	handler_getFromTableList ($tableList)
	handler_init ($handlerKey)
	isConnected ()
	runningNative ()
	runningADOdbDriver ($driver)
	getServerVersion ()
	debugHandler ($function, $execTime, $inData)
	debug_WHERE ($table, $where, $script='')
	debug_log ($query, $ms, $data, $join, $errorFlag, $script='')
	debug_explain ($query)
Public Member Functions inherited from TYPO3\CMS\Core\Database\DatabaseConnection
static	initialize ()
	exec_SELECT_mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause='', $groupBy='', $orderBy='', $limit='')
	exec_SELECT_queryArray ($queryParts)
	exec_SELECTgetRows ($select_fields, $from_table, $where_clause, $groupBy='', $orderBy='', $limit='', $uidIndexField='')
	exec_SELECTgetSingleRow ($select_fields, $from_table, $where_clause, $groupBy='', $orderBy='', $numIndex=false)
	exec_SELECTcountRows ($field, $table, $where='1=1')
	INSERTquery ($table, $fields_values, $no_quote_fields=false)
	SELECTsubquery ($select_fields, $from_table, $where_clause)
	SELECT_mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause='', $groupBy='', $orderBy='', $limit='')
	listQuery ($field, $value, $table)
	searchQuery ($searchWords, $fields, $table, $constraint=self::AND_Constraint)
	prepare_SELECTqueryArray (array $queryParts, array $input_parameters=[])
	prepare_PREPAREDquery ($query, array $queryComponents)
	fullQuoteStr ($str, $table, $allowNull=false)
	fullQuoteArray ($arr, $table, $noQuote=false, $allowNull=false)
	quoteStr ($str, $table)
	escapeStrForLike ($str, $table)
	cleanIntArray ($arr)
	cleanIntList ($list)
	stripOrderBy ($str)
	stripGroupBy ($str)
	splitGroupOrderLimit ($str)
	getDateTimeFormats ($table)
	sql_query ($query)
	sql_error ()
	sql_errno ()
	sql_num_rows ($res)
	sql_fetch_assoc ($res)
	sql_fetch_row ($res)
	sql_free_result ($res)
	sql_insert_id ()
	sql_affected_rows ()
	sql_data_seek ($res, $seek)
	sql_field_type ($res, $pointer)
	sql_pconnect ()
	sql_select_db ()
	admin_get_dbs ()
	admin_get_tables ()
	admin_get_fields ($tableName)
	admin_get_keys ($tableName)
	admin_get_charsets ()
	admin_query ($query)
	setDatabaseHost ($host='localhost')
	setDatabasePort ($port=3306)
	setDatabaseSocket ($socket=null)
	setDatabaseName ($name)
	setDatabaseUsername ($username)
	setDatabasePassword ($password)
	setPersistentDatabaseConnection ($persistentDatabaseConnection)
	setConnectionCompression ($connectionCompression)
	setInitializeCommandsAfterConnect (array $commands)
	setConnectionCharset ($connectionCharset='utf8')
	connectDB ()
	isConnected ()
	getDatabaseHandle ()
	setDatabaseHandle ($handle)
	getServerVersion ()
	debug ($func, $query='')
	debug_check_recordset ($res)
	__sleep ()

Public Attributes
	$debug = false
	$conf = []
	$mapping = []
	$handlerCfg
	$handlerInstance = []
	$lastHandlerKey = ''
	$cache_autoIncFields = []
	$cache_fieldType = []
	$cache_primaryKeys = []
	$SQLparser
	MYSQLI_TYPE_CHAR
Public Attributes inherited from TYPO3\CMS\Core\Database\DatabaseConnection
const	AND_Constraint = 'AND'
const	OR_Constraint = 'OR'
	$debugOutput = false
	$debug_lastBuiltQuery = ''
	$store_lastBuiltQuery = false
	$explainOutput = 0
	$default_charset = 'utf8'

Protected Member Functions
	getFieldInfoCache ()
	analyzeCachingTables ()
	analyzeExtensionTables ()
	parseAndAnalyzeSql ($sql)
	getCompleteFieldInformation ()
	getCacheableString (array $fieldInformation)
	analyzeFields ($parsedExtSQL)
	mapCachedFieldInfo (array $fieldInfo)
	exec_query (array $queryParts)
	query ($query)
	SELECTqueryFromArray (array $params)
	compileSelectParameters (array $params)
	getQueryComponents ($select_fields, $from_table, $where_clause, $groupBy, $orderBy, $limit)
	precompileSELECTquery (array $components)
	quoteSELECTsubquery (array $components)
	_quoteFieldNames (array $select_fields)
	_quoteFromTables (array $from_table)
	_quoteWhereClause (array $where_clause)
	quoteGroupBy ($groupBy)
	_quoteGroupBy (array $groupBy)
	quoteOrderBy ($orderBy)
	_quoteOrderBy (array $orderBy)
	updateLastInsertId ($table, array $fieldValues)
	determineHandlerType ($res)
	map_needMapping ($tableList, $fieldMappingOnly=false, array &$parsedTableList=[])
	map_assocArray ($input, $tables, $rev=false)
	map_remapSELECTQueryParts ($select_fields, $from_table, $where_clause, $groupBy, $orderBy)
	getMappingKey ($tableName)
	getFreeMappingKey ($tableName)
	map_sqlParts (&$sqlPartArray, $defaultTable)
	map_subquery (&$parsedQuery)
	map_genericQueryParsed (&$parsedQuery)
	map_fieldNamesInArray ($table, &$fieldArray)
Protected Member Functions inherited from TYPO3\CMS\Core\Database\DatabaseConnection
	query ($query)
	getSelectMmQueryParts ($select, $local_table, $mm_table, $foreign_table, $whereClause='', $groupBy='', $orderBy='', $limit='')
	checkConnectionCharset ()
	disconnectIfConnected ()
	explain ($query, $from_table, $row_count)

Protected Attributes
	$printErrors = false
	$table2handlerKeys = []
	$lastQuery = ''
	$lastParsedAndMappedQueryArray = []
	$resourceIdToTableNameMap = []
	$cache_handlerKeyFromTableList = []
	$cache_mappingFromTableList = []
	$cacheIdentifier = 'DatabaseConnection_fieldInfo'
	$installerSql = null
	$queryCache
	$mysqlDataTypeMapping
	$dbmsSpecifics
Protected Attributes inherited from TYPO3\CMS\Core\Database\DatabaseConnection
	$databaseHost = ''
	$databasePort = 3306
	$databaseSocket = null
	$databaseName = ''
	$databaseUsername = ''
	$databaseUserPassword = ''
	$persistentDatabaseConnection = false
	$connectionCompression = false
	$connectionCharset = 'utf8'
	$initializeCommandsAfterConnect = []
	$isConnected = false
	$link = null
	$preProcessHookObjects = []
	$postProcessHookObjects = []

Additional Inherited Members
Static Protected Attributes inherited from TYPO3\CMS\Core\Database\DatabaseConnection
static	$dateTimeFormats

Detailed Description

TYPO3 database abstraction layer

Definition at line 22 of file DatabaseConnection.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Dbal\Database\DatabaseConnection::__construct

(

)

Constructor. Creates SQL parser object and imports configuration from $TYPO3_CONF_VARS['EXTCONF']['dbal']

Definition at line 210 of file DatabaseConnection.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

_quoteFieldNames()

TYPO3\CMS\Dbal\Database\DatabaseConnection::_quoteFieldNames ( array  $select_fields )

protected

Quotes field (and table) names in a SQL SELECT clause according to DB rules

Parameters

array

$select_fields

The parsed fields to quote

Returns

array

See also

quoteFieldNames()

Definition at line 1655 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteName().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteSELECTsubquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray().

_quoteFromTables()

TYPO3\CMS\Dbal\Database\DatabaseConnection::_quoteFromTables ( array  $from_table )

protected

Quotes table names in a SQL FROM clause according to DB rules

Parameters

array

$from_table

The parsed FROM clause to quote

Returns

array

See also

quoteFromTables()

Definition at line 1712 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteName().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteSELECTsubquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray().

_quoteGroupBy()

TYPO3\CMS\Dbal\Database\DatabaseConnection::_quoteGroupBy ( array  $groupBy )

protected

Quotes field names in a SQL GROUP BY clause according to DB rules

Parameters

array

$groupBy

The parsed GROUP BY clause to quote

Returns

array

See also

quoteGroupBy()

Definition at line 1886 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteName().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteGroupBy(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray().

_quoteOrderBy()

TYPO3\CMS\Dbal\Database\DatabaseConnection::_quoteOrderBy ( array  $orderBy )

protected

Quotes field names in a SQL ORDER BY clause according to DB rules

Parameters

array

$orderBy

The parsed ORDER BY clause to quote

Returns

array

See also

quoteOrderBy()

Definition at line 1924 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteName().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteOrderBy(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray().

_quoteWhereClause()

TYPO3\CMS\Dbal\Database\DatabaseConnection::_quoteWhereClause ( array  $where_clause )

protected

Quotes field names in a SQL WHERE clause according to DB rules

Parameters

array

$where_clause

The parsed WHERE clause to quote

Returns

array

See also

quoteWhereClause()

Definition at line 1764 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Database\DatabaseConnection\escapeStrForLike(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteName(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteSELECTsubquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningADOdbDriver().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteSELECTsubquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray().

admin_get_tables()

TYPO3\CMS\Dbal\Database\DatabaseConnection::admin_get_tables

(

)

Returns the list of tables from the default database, TYPO3_db (quering the DBMS) In a DBAL this method should 1) look up all tables from the DBMS of the _DEFAULT handler and then 2) add all tables configured to be managed by other handlers

Returns

array Array with tablenames as key and arrays with status information as value

Definition at line 2736 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\admin_get_charsets(), TYPO3\CMS\Core\Database\DatabaseConnection\admin_get_fields(), TYPO3\CMS\Core\Database\DatabaseConnection\admin_get_keys(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getMetadata(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_assoc().

admin_query()

TYPO3\CMS\Dbal\Database\DatabaseConnection::admin_query

(

$query

)

mysqli() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!

Parameters

string

$query

Query to execute

Exceptions

Definition at line 2994 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Dbal\Database\DatabaseConnection\clearCachedFieldInfo(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_genericQueryParsed(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\query().

analyzeCachingTables()

TYPO3\CMS\Dbal\Database\DatabaseConnection::analyzeCachingTables ( )

protected

Loop through caching configurations to find the usage of database backends and parse and analyze table definitions

Returns

void

Definition at line 316 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\parseAndAnalyzeSql().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\cacheFieldInfo().

analyzeExtensionTables()

TYPO3\CMS\Dbal\Database\DatabaseConnection::analyzeExtensionTables ( )

protected

Loop over all installed extensions parse and analyze table definitions (if any)

Returns

void

Definition at line 328 of file DatabaseConnection.php.

References $GLOBALS, and TYPO3\CMS\Dbal\Database\DatabaseConnection\parseAndAnalyzeSql().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\cacheFieldInfo().

analyzeFields()

TYPO3\CMS\Dbal\Database\DatabaseConnection::analyzeFields (   $parsedExtSQL )

protected

Analyzes fields and adds the extracted information to the field type, auto increment and primary key info caches.

Parameters

array

$parsedExtSQL

The output produced by ->getFieldDefinitions_fileContent()

Returns

void

Definition at line 386 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\parseAndAnalyzeSql().

cacheFieldInfo()

TYPO3\CMS\Dbal\Database\DatabaseConnection::cacheFieldInfo

(

)

Caches the field information.

Returns

void

Definition at line 291 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\analyzeCachingTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\analyzeExtensionTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getCacheableString(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getCompleteFieldInformation(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\getFieldInfoCache().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\initialize().

clearCachedFieldInfo()

TYPO3\CMS\Dbal\Database\DatabaseConnection::clearCachedFieldInfo

(

)

Clears the cached field information file.

Returns

void

Definition at line 281 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\getFieldInfoCache().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query().

compileSelectParameters()

TYPO3\CMS\Dbal\Database\DatabaseConnection::compileSelectParameters ( array  $params )

protected

Compiles and returns an array of SELECTquery parameters (without $limit) to be used with SELECTquery() or exec_SELECTquery().

Parameters

array

$params

Returns

array array($select_fields, $from_table, $where_clause, $groupBy, $orderBy)

Definition at line 1318 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray().

debug_explain()

TYPO3\CMS\Dbal\Database\DatabaseConnection::debug_explain

(

$query

)

Perform EXPLAIN query on DEFAULT handler!

Parameters

string

$query

SELECT Query

Returns

array The Explain result rows in an array

Definition at line 4017 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_assoc(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_query().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler().

debug_log()

TYPO3\CMS\Dbal\Database\DatabaseConnection::debug_log	(		$query,
			$ms,
			$data,
			$join,
			$errorFlag,
			$script = ''
	)

Inserts row in the log table

Parameters

string	$query	The current query
int	$ms	Execution time of query in milliseconds
array	$data	Data to be stored serialized.
string	$join	Join string if there IS a join.
int	$errorFlag	Error status.
string	$script	The script calling the logging

Returns

void

Definition at line 3985 of file DatabaseConnection.php.

References $GLOBALS, and TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler().

debug_WHERE()

TYPO3\CMS\Dbal\Database\DatabaseConnection::debug_WHERE	(		$table,
			$where,
			$script = ''
	)

Logs the where clause for debugging purposes.

Parameters

string	$table	Table name(s) the query was targeted at
string	$where	The WHERE clause to be logged
string	$script	The script calling the logging

Returns

void

Definition at line 3962 of file DatabaseConnection.php.

References $GLOBALS, and TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler().

debugHandler()

TYPO3\CMS\Dbal\Database\DatabaseConnection::debugHandler	(		$function,
			$execTime,
			$inData
	)

Debug handler for query execution

Parameters

string	$function	Function name from which this function is called.
string	$execTime	Execution time in ms of the query
array	$inData	In-data of various kinds.

Returns

void private

Definition at line 3869 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastQuery, TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_explain(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_log(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_WHERE(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_affected_rows(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\precompileSELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery().

DELETEquery()

TYPO3\CMS\Core\Database\DatabaseConnection::DELETEquery	(		$table,
			$where
	)

Creates a DELETE SQL-statement for $table where $where-clause

Parameters

string	$table	See exec_DELETEquery()
string	$where	See exec_DELETEquery()

Returns

string Full SQL query for DELETE

Exceptions

Definition at line 1218 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery().

determineHandlerType()

TYPO3\CMS\Dbal\Database\DatabaseConnection::determineHandlerType (   $res )

protected

Determine handler type by result set

Parameters

bool | \mysqli_result | object

$res

MySQLi result set / DBAL Object

Returns

bool|string

Definition at line 2437 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_data_seek(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_assoc(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_row(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_field_type(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_free_result(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_num_rows().

exec_DELETEquery()

TYPO3\CMS\Core\Database\DatabaseConnection::exec_DELETEquery	(		$table,
			$where
	)

Creates and executes a DELETE SQL-statement for $table where $where-clause

Parameters

string	$table	Database tablename
string	$where	WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!

Returns

bool||object MySQLi result object / DBAL object

Definition at line 733 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_sqlParts(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_query().

exec_INSERTmultipleRows()

TYPO3\CMS\Core\Database\DatabaseConnection::exec_INSERTmultipleRows	(		$table,
		array	$fields,
		array	$rows,
			$no_quote_fields = false
	)

Creates and executes an INSERT SQL-statement for $table with multiple rows.

Parameters

string	$table	Table name
array	$fields	Field names
array	$rows	Table rows. Each row should be an array with field values mapping to $fields
bool | array | string	$no_quote_fields	See fullQuoteArray()

Returns

bool||object MySQLi result object / DBAL object

Definition at line 618 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\query().

exec_INSERTquery()

TYPO3\CMS\Core\Database\DatabaseConnection::exec_INSERTquery	(		$table,
			$fields_values,
			$no_quote_fields = false
	)

Creates and executes an INSERT SQL-statement for $table from the array with field/value pairs $fields_values. Using this function specifically allows us to handle BLOB and CLOB fields depending on DB

Parameters

string	$table	Table name
array	$fields_values	Field values as key=>value pairs. Values will be escaped internally. Typically you would fill an array like "$insertFields" with 'fieldname'=>'value' and pass it to this function as argument.
bool | array | string	$no_quote_fields	See fullQuoteArray()

Returns

bool||object MySQLi result object / DBAL object

Exceptions

Definition at line 485 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\fullQuoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_assocArray(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_insert_id(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\updateLastInsertId().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_log(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_WHERE(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTmultipleRows(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_query().

exec_query()

TYPO3\CMS\Dbal\Database\DatabaseConnection::exec_query ( array  $queryParts )

protected

Executes a query. EXPERIMENTAL since TYPO3 4.4.

Parameters

array

$queryParts

SQL parsed by method parseSQL() of

Returns

|object MySQLi result object / DBAL object

See also

self::sql_query()

Definition at line 948 of file DatabaseConnection.php.

References $GLOBALS, TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_query().

exec_SELECTquery()

TYPO3\CMS\Core\Database\DatabaseConnection::exec_SELECTquery	(		$select_fields,
			$from_table,
			$where_clause,
			$groupBy = '',
			$orderBy = '',
			$limit = ''
	)

Creates and executes a SELECT SQL-statement Using this function specifically allow us to handle the LIMIT feature independently of DB.

Parameters

string	$select_fields	List of fields to select from the table. This is what comes right after "SELECT ...". Required value.
string	$from_table	Table(s) from which to select. This is what comes right after "FROM ...". Required value.
string	$where_clause	Additional WHERE clauses put in the end of the query. NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself! DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	$groupBy	Optional GROUP BY field(s), if none, supply blank string.
string	$orderBy	Optional ORDER BY field(s), if none, supply blank string.
string	$limit	Optional LIMIT value ([begin,]max), if none, supply blank string.

Exceptions

Definition at line 795 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Dbal\Database\DatabaseConnection\compileSelectParameters(), TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_remapSELECTQueryParts(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTqueryFromArray(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_num_rows().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_query().

exec_TRUNCATEquery()

TYPO3\CMS\Core\Database\DatabaseConnection::exec_TRUNCATEquery

(

$table

)

Truncates a table.

Parameters

string

$table

Database tablename

Returns

mixed Result from handler

Definition at line 895 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\TRUNCATEquery().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_query().

exec_UPDATEquery()

TYPO3\CMS\Core\Database\DatabaseConnection::exec_UPDATEquery	(		$table,
			$where,
			$fields_values,
			$no_quote_fields = false
	)

Creates and executes an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values. Using this function specifically allow us to handle BLOB and CLOB fields depending on DB

Parameters

string	$table	Database tablename
string	$where	WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
array	$fields_values	Field values as key=>value pairs. Values will be escaped internally. Typically you would fill an array like "$updateFields" with 'fieldname'=>'value' and pass it to this function as argument.
bool | array | string	$no_quote_fields	See fullQuoteArray()

Returns

bool||object MySQLi result object / DBAL object

Definition at line 649 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\fullQuoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_assocArray(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_sqlParts(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_query().

fullQuoteStr()

TYPO3\CMS\Dbal\Database\DatabaseConnection::fullQuoteStr	(		$str,
			$table,
			$allowNull = false
	)

Escaping and quoting values for SQL statements.

Parameters

string	$str	Input string
string	$table	Table name for which to quote string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).
bool	$allowNull	Whether to allow NULL values

Returns

string Output string; Wrapped in single quotes and quotes in the string (" / ') and \ will be backslashed (or otherwise based on DBAL handler)

See also

quoteStr()

Definition at line 1952 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteStr().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

getCacheableString()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getCacheableString ( array  $fieldInformation )

protected

Creates a PHP code representation of the array that can be cached in the PHP code cache.

Parameters

array

$fieldInformation

Returns

string

Definition at line 372 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\cacheFieldInfo().

getCompleteFieldInformation()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getCompleteFieldInformation ( )

protected

Returns all field information gathered during analyzing all tables and fields.

Returns

array

Definition at line 360 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$cache_autoIncFields, TYPO3\CMS\Dbal\Database\DatabaseConnection\$cache_fieldType, and TYPO3\CMS\Dbal\Database\DatabaseConnection\$cache_primaryKeys.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\cacheFieldInfo().

getEquivalentFieldDefinition()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getEquivalentFieldDefinition

(

$fieldSQL

)

Convert the native MySQL Field type to the closest matching equivalent field type supported by the DBMS. INTEGER and TINYTEXT colums need to be further processed due to MySQL limitations / non-standard features.

Parameters

string

$fieldSQL

Returns

string

Definition at line 2163 of file DatabaseConnection.php.

getEquivalentIndexDefinition()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getEquivalentIndexDefinition

(

$indexSQL

)

Remove the index prefix length information from columns in an index definition. Partial indexes based on a prefix are not supported by all databases.

Parameters

string

$indexSQL

Returns

string

Definition at line 2139 of file DatabaseConnection.php.

getFieldInfoCache()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getFieldInfoCache ( )

protected

Returns

Definition at line 271 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\cacheFieldInfo(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\clearCachedFieldInfo().

getFreeMappingKey()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getFreeMappingKey (   $tableName )

protected

Returns a free key to be used to store mapping information in $this->mapping.

Parameters

string

$tableName

Returns

string

Definition at line 3524 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\map_remapSELECTQueryParts(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_subquery().

getMappingKey()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getMappingKey (   $tableName )

protected

Returns the key to be used when retrieving information from $this->mapping. This ensures that mapping from aliased tables is properly retrieved.

Parameters

string

$tableName

Returns

string

Definition at line 3509 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\map_assocArray(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_remapSELECTQueryParts(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_sqlParts(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_subquery().

getMetadata()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getMetadata	(		$type,
			$table,
			$field,
			$maxLength = -1
	)

Return Metadata for native field type (ADOdb only!)

Parameters

string	$type	Native type as reported by admin_get_fields()
string	$table	Table name for which the type is queried. Important for detection of DBMS handler of the query!
string	$field	Field name for which the type is queried. Important for accessing the field information cache.
int	$maxLength

Exceptions

Definition at line 2051 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, $rs, TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\MetaType().

getQueryComponents()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getQueryComponents (   $select_fields,   $from_table,   $where_clause,   $groupBy,   $orderBy,   $limit  )

protected

Returns the parsed query components.

Parameters

string	$select_fields
string	$from_table
string	$where_clause
string	$groupBy
string	$orderBy
string	$limit

Exceptions

Definition at line 1457 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningADOdbDriver().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery().

getServerVersion()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getServerVersion

(

)

Get the SQL server version

Returns

string

Definition at line 3297 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

getSpecifics()

TYPO3\CMS\Dbal\Database\DatabaseConnection::getSpecifics

(

)

Gets the DBMS specifics object

Returns

Specifics

Definition at line 263 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$dbmsSpecifics.

handler_getFromTableList()

TYPO3\CMS\Dbal\Database\DatabaseConnection::handler_getFromTableList

(

$tableList

)

Return the handler key pointing to an appropriate database handler as found in $this->handlerCfg array Notice: TWO or more tables in the table list MUST use the SAME handler key - otherwise a fatal error is thrown! (Logically, no database can possibly join two tables from separate sources!)

Parameters

string

$tableList

Table list, eg. "pages" or "pages, tt_content" or "pages AS A, tt_content AS B

Exceptions

Definition at line 3077 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_init().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTmultipleRows(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getMetadata(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getQueryComponents(), TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\precompileSELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

handler_init()

TYPO3\CMS\Dbal\Database\DatabaseConnection::handler_init

(

$handlerKey

)

Initialize handler (connecting to database)

Parameters

string

$handlerKey

Handler key

Returns

bool If connection went well, return TRUE

Exceptions

Definition at line 3117 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Database\DatabaseConnection\$databaseHost, TYPO3\CMS\Core\Database\DatabaseConnection\$databaseName, TYPO3\CMS\Core\Database\DatabaseConnection\$databaseUsername, TYPO3\CMS\Core\Database\DatabaseConnection\$databaseUserPassword, $dsn, $GLOBALS, $host, TYPO3\CMS\Core\Database\DatabaseConnection\$link, TYPO3\CMS\Core\Database\DatabaseConnection\checkConnectionCharset(), TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Dbal\Database\DatabaseConnection\isConnected(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_ERROR, and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_FATAL.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_pconnect().

initialize()

TYPO3\CMS\Dbal\Database\DatabaseConnection::initialize

(

)

Initialize the database connection

Returns

void

Definition at line 225 of file DatabaseConnection.php.

References $driver, TYPO3\CMS\Dbal\Database\DatabaseConnection\cacheFieldInfo(), TYPO3\CMS\Core\Database\DatabaseConnection\debug(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

INSERTmultipleRows()

TYPO3\CMS\Core\Database\DatabaseConnection::INSERTmultipleRows	(		$table,
		array	$fields,
		array	$rows,
			$no_quote_fields = false
	)

Creates an INSERT SQL-statement for $table with multiple rows.

Parameters

string	$table	Table name
array	$fields	Field names
array	$rows	Table rows. Each row should be an array with field values mapping to $fields
bool | array | string	$no_quote_fields	See fullQuoteArray()

Returns

string|array Full SQL query for INSERT (unless $rows does not contain any elements in which case it will be FALSE)

Creates an INSERT SQL-statement for $table with multiple rows.

Parameters

string	$table	Table name
array	$fields	Field names
array	$rows	Table rows. Each row should be an array with field values mapping to $fields
bool | array | string	$no_quote_fields	See fullQuoteArray()

Returns

string|NULL Full SQL query for INSERT, NULL if $rows is empty

Definition at line 1105 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery().

INSERTquery()

TYPO3\CMS\Dbal\Database\DatabaseConnection::INSERTquery	(		$table,
			$fields_values,
			$no_quote_fields = false
	)

Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.

Parameters

string	$table	See exec_INSERTquery()
array	$fields_values	See exec_INSERTquery()
bool | array | string	$no_quote_fields	See fullQuoteArray()

Returns

string|NULL Full SQL query for INSERT, NULL if $rows is empty

Definition at line 1022 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\fullQuoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_field_metatype().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTmultipleRows().

isConnected()

TYPO3\CMS\Dbal\Database\DatabaseConnection::isConnected

(

)

Checks if database is connected.

Returns

bool

Definition at line 3255 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_init(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteStr(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_query().

map_assocArray()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_assocArray (   $input,   $tables,   $rev = false  )

protected

Takes an associated array with field => value pairs and remaps the field names if configured for this table in $this->mapping array. Be careful not to map a field name to another existing fields name (although you can use this to swap fieldnames of course...:-) Observe mapping problems with join-results (more than one table): Joined queries should always prefix the table name to avoid problems with this. Observe that alias fields are not mapped of course (should not be a problem though)

Parameters

array	$input	Input array, associative keys
array	$tables	Array of tables from the query. Normally just one table; many tables in case of a join. NOTICE: for multiple tables (with joins) there MIGHT occur trouble with fields of the same name in the two tables: This function traverses the mapping information for BOTH tables and applies mapping without checking from which table the field really came!
bool	$rev	If TRUE, reverse direction. Default direction is to map an array going INTO the database (thus mapping TYPO3 fieldnames to PHYSICAL field names!)

Returns

array Output array, with mapped associative keys.

Definition at line 3378 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\getMappingKey().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_assoc().

map_fieldNamesInArray()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_fieldNamesInArray (   $table, &  $fieldArray  )

protected

Re-mapping field names in array

Parameters

string	$table	(TYPO3) Table name for fields.
array	$fieldArray	Array of fieldnames to remap. Notice: Passed by reference!

Returns

void

Definition at line 3798 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\map_genericQueryParsed().

map_genericQueryParsed()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_genericQueryParsed ( &  $parsedQuery )

protected

Will do table/field mapping on a general -compliant SQL query (May still not support all query types...)

Parameters

array

$parsedQuery

Parsed QUERY as from ::parseSQL(). NOTICE: Passed by reference!

Exceptions

Definition at line 3738 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\map_fieldNamesInArray(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query().

map_needMapping()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_needMapping (   $tableList,   $fieldMappingOnly = false, array &  $parsedTableList = []  )

protected

Checks if mapping is needed for a table(list)

Parameters

string	$tableList	List of tables in query
bool	$fieldMappingOnly	If TRUE, it will check only if FIELDs are configured and ignore the mapped table name if any.
array	$parsedTableList	Parsed list of tables, should be passed as reference to be reused and prevent double parsing

Returns

mixed Returns an array of table names (parsed version of input table) if mapping is needed, otherwise just FALSE.

Definition at line 3328 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_genericQueryParsed(), TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_assoc().

map_remapSELECTQueryParts()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_remapSELECTQueryParts (   $select_fields,   $from_table,   $where_clause,   $groupBy,   $orderBy  )

protected

Remaps table/field names in a SELECT query's parts

Parameters

mixed	$select_fields	Either parsed list of tables (SQLparser->parseFromTables()) or list of fields to select from the table. This is what comes right after "SELECT ...". Required value.
string	$from_table	Table(s) from which to select. This is what comes right after "FROM ...". Require value.
string	$where_clause	Where clause. This is what comes right after "WHERE ...". Can be blank.
string	$groupBy	Group by field(s)
string	$orderBy	Order by field(s)

Returns

array

See also

exec_SELECTquery()

Definition at line 3421 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$mapping, TYPO3\CMS\Dbal\Database\DatabaseConnection\getFreeMappingKey(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getMappingKey(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_sqlParts().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery().

map_sqlParts()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_sqlParts ( &  $sqlPartArray,   $defaultTable  )

protected

Generic mapping of table/field names arrays (as parsed by )

Parameters

array	$sqlPartArray	Array with parsed SQL parts; Takes both fields, tables, where-parts, group and order-by. Passed by reference.
string	$defaultTable	Default table name to assume if no table is found in $sqlPartArray

Returns

void

See also

map_remapSELECTQueryParts()

Definition at line 3540 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\getMappingKey(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_subquery().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_remapSELECTQueryParts(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_subquery().

map_subquery()

TYPO3\CMS\Dbal\Database\DatabaseConnection::map_subquery ( &  $parsedQuery )

protected

Maps table and field names in a subquery.

Parameters

array

$parsedQuery

Returns

void

Definition at line 3699 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$mapping, TYPO3\CMS\Dbal\Database\DatabaseConnection\getFreeMappingKey(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getMappingKey(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_sqlParts().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\map_sqlParts().

mapCachedFieldInfo()

TYPO3\CMS\Dbal\Database\DatabaseConnection::mapCachedFieldInfo ( array  $fieldInfo )

protected

This function builds all definitions for mapped tables and fields

Parameters

array

$fieldInfo

Returns

array

See also

cacheFieldInfo()

Definition at line 426 of file DatabaseConnection.php.

References $GLOBALS.

MetaType()

TYPO3\CMS\Dbal\Database\DatabaseConnection::MetaType	(		$type,
			$table,
			$maxLength = -1
	)

Return MetaType for native field type (ADOdb only!)

Parameters

string	$type	Native type as reported by admin_get_fields()
string	$table	Table name for which query type string. Important for detection of DBMS handler of the query!
int	$maxLength

Exceptions

Definition at line 2035 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\getMetadata(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

MySQLActualType()

TYPO3\CMS\Dbal\Database\DatabaseConnection::MySQLActualType

(

$meta

)

Return actual MySQL type for meta field type

Parameters

string

$meta

Meta type (currenly ADOdb syntax only, http://phplens.com/lens/adodb/docs-adodb.htm#metatype)

Returns

string Native type as reported as in mysqldump files, uppercase

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 2096 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

MySQLMetaType()

TYPO3\CMS\Dbal\Database\DatabaseConnection::MySQLMetaType

(

$t

)

Return MetaType for native MySQL field type

Parameters

string

$t

native type as reported as in mysqldump files

Returns

string Meta type (currently ADOdb syntax only, http://phplens.com/lens/adodb/docs-adodb.htm#metatype)

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 2083 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

parseAndAnalyzeSql()

TYPO3\CMS\Dbal\Database\DatabaseConnection::parseAndAnalyzeSql (   $sql )

protected

Parse and analyze given SQL string

Parameters

$sql

Returns

void

Definition at line 348 of file DatabaseConnection.php.

References $sql, and TYPO3\CMS\Dbal\Database\DatabaseConnection\analyzeFields().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\analyzeCachingTables(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\analyzeExtensionTables().

precompileSELECTquery()

TYPO3\CMS\Dbal\Database\DatabaseConnection::precompileSELECTquery ( array  $components )

protected

Precompiles a SELECT prepared SQL statement.

Parameters

array

$components

Returns

array Precompiled SQL statement

Definition at line 1503 of file DatabaseConnection.php.

References $params, TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Core\Database\DatabaseConnection\prepare_PREPAREDquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery().

prepare_SELECTquery()

TYPO3\CMS\Core\Database\DatabaseConnection::prepare_SELECTquery	(		$select_fields,
			$from_table,
			$where_clause,
			$groupBy = '',
			$orderBy = '',
			$limit = '',
		array	$input_parameters = []
	)

Creates a SELECT prepared SQL statement.

Parameters

string	$select_fields	See exec_SELECTquery()
string	$from_table	See exec_SELECTquery()
string	$where_clause	See exec_SELECTquery()
string	$groupBy	See exec_SELECTquery()
string	$orderBy	See exec_SELECTquery()
string	$limit	See exec_SELECTquery()
array	$input_parameters	An array of values with as many elements as there are bound parameters in the SQL statement being executed. All values are treated as ::PARAM_AUTOTYPE.

Returns

Prepared statement

Definition at line 1365 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteGroupBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteOrderBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause(), TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Dbal\QueryCache\getCacheKey(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getQueryComponents(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_remapSELECTQueryParts(), TYPO3\CMS\Core\Utility\GeneralUtility\milliseconds(), TYPO3\CMS\Dbal\Database\DatabaseConnection\precompileSELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative().

query()

TYPO3\CMS\Dbal\Database\DatabaseConnection::query (   $query )

protected

Central query method. Also checks if there is a database connection. Use this to execute database queries instead of directly calling $this->link->query()

Parameters

string

$query

The query to send to the database

Returns

bool|

Definition at line 1001 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\connectDB(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\isConnected().

Referenced by TYPO3\CMS\Dbal\Database\AdodbPreparedStatement\__construct(), TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTmultipleRows(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_init(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_select_db().

quoteFieldNames()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteFieldNames

(

$select_fields

)

Quotes field (and table) names with the quote character suitable for the DB being used

Parameters

string

$select_fields

List of fields to be used in query to DB

Exceptions

Definition at line 1632 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause(), TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

quoteFromTables()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteFromTables

(

$from_table

)

Quotes table names with the quote character suitable for the DB being used

Parameters

string

$from_table

List of tables to be selected from DB

Returns

string Quoted list of tables to be selected from DB

Definition at line 1692 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFromTables(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getMetadata(), TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\TRUNCATEquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

quoteGroupBy()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteGroupBy (   $groupBy )

protected

Quotes the field (and table) names within a group by clause with the quote character suitable for the DB being used

Parameters

string

$groupBy

A group by clause that can by parsed by parseFieldList

Returns

string Usable group by clause with quoted field/table names

Definition at line 1866 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteGroupBy(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery().

quoteName()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteName	(		$name,
			$handlerKey = null,
			$useBackticks = false
	)

Quotes an object name (table name, field, ...)

Parameters

string	$name	Object's name
string	$handlerKey	Handler key
bool	$useBackticks	If method NameQuote() is not used, whether to use backticks instead of driver-specific quotes

Returns

string Properly-quoted object's name

Definition at line 2009 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteGroupBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteOrderBy(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause().

quoteOrderBy()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteOrderBy (   $orderBy )

protected

Quotes the field (and table) names within an order by clause with the quote character suitable for the DB being used

Parameters

string

$orderBy

An order by clause that can by parsed by parseFieldList

Returns

string Usable order by clause with quoted field/table names

Definition at line 1904 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteOrderBy(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery().

quoteSELECTsubquery()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteSELECTsubquery ( array  $components )

protected

Quotes components of a SELECT subquery.

Parameters

array

$components

Array of SQL query components

Returns

array

Definition at line 1617 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFromTables(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause().

quoteStr()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteStr	(		$str,
			$table
	)

Substitution for PHP function "addslashes()" Use this function instead of the PHP addslashes() function when you build queries - this will prepare your code for DBAL. NOTICE: You must wrap the output of this function in SINGLE QUOTES to be DBAL compatible. Unless you have to apply the single quotes yourself you should rather use ->fullQuoteStr()!

Parameters

string	$str	Input string
string	$table	Table name for which to quote string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).

Exceptions

Definition at line 1971 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\connectDB(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\isConnected().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\fullQuoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

quoteWhereClause()

TYPO3\CMS\Dbal\Database\DatabaseConnection::quoteWhereClause

(

$where_clause

)

Quotes the field (and table) names within a where clause with the quote character suitable for the DB being used

Parameters

string

$where_clause

A where clause that can be parsed by parseWhereClause

Exceptions

Definition at line 1742 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

runningADOdbDriver()

TYPO3\CMS\Dbal\Database\DatabaseConnection::runningADOdbDriver

(

$driver

)

Checks whether the ADOdb handler is running with a driver that contains the argument

Parameters

string

$driver

Driver name, matched with strstr().

Returns

bool True if running with the given driver

Definition at line 3287 of file DatabaseConnection.php.

References $driver.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getQueryComponents(), TYPO3\CMS\Dbal\Database\DatabaseConnection\SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_assoc(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_fetch_row().

runningNative()

TYPO3\CMS\Dbal\Database\DatabaseConnection::runningNative

(

)

Checks whether the DBAL is currently inside an operation running on the "native" DB handler (i.e. MySQL)

Returns

bool TRUE if running on "native" DB handler (i.e. MySQL)

Definition at line 3276 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteGroupBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteOrderBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

SELECTquery()

TYPO3\CMS\Core\Database\DatabaseConnection::SELECTquery	(		$select_fields,
			$from_table,
			$where_clause,
			$groupBy = '',
			$orderBy = '',
			$limit = ''
	)

Creates a SELECT SQL-statement

Parameters

string	$select_fields	See exec_SELECTquery()
string	$from_table	See exec_SELECTquery()
string	$where_clause	See exec_SELECTquery()
string	$groupBy	See exec_SELECTquery()
string	$orderBy	See exec_SELECTquery()
string	$limit	See exec_SELECTquery()

Returns

string Full SQL query for SELECT

Definition at line 1247 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteGroupBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteOrderBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningADOdbDriver().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery().

SELECTqueryFromArray()

TYPO3\CMS\Dbal\Database\DatabaseConnection::SELECTqueryFromArray ( array  $params )

protected

Creates a SELECT SQL-statement to be used with an ADOdb backend.

Parameters

array

$params

parsed parameters: array($select_fields, $from_table, $where_clause, $groupBy, $orderBy)

Returns

string Full SQL query for SELECT

Definition at line 1282 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteGroupBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteOrderBy(), TYPO3\CMS\Dbal\Database\DatabaseConnection\_quoteWhereClause(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\compileSelectParameters().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery().

sql_affected_rows()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_affected_rows

(

)

Returns the number of rows affected by the last INSERT, UPDATE or DELETE query

Returns

int Number of rows affected by last query

Definition at line 2476 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler().

sql_data_seek()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_data_seek	(		$res,
			$seek
	)

Move internal result pointer

Parameters

bool | \mysqli_result | object	$res	MySQLi result object / DBAL object
int	$seek	Seek result number.

Returns

bool Returns TRUE on success or FALSE on failure.

Definition at line 2500 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\determineHandlerType().

sql_errno()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_errno

(

)

Returns the error number on the last query() execution

Returns

int MySQLi error number

Definition at line 2229 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

sql_error()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_error

(

)

Returns the error status on the last query() execution

Returns

string MySQLi error string.

Definition at line 2207 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_init(), TYPO3\CMS\Dbal\Database\DatabaseConnection\precompileSELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_query(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_select_db().

sql_fetch_assoc()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_fetch_assoc

(

$res

)

Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows. MySQLi fetch_assoc() wrapper function

Parameters

bool | \mysqli_result | object

$res

MySQLi result object / DBAL object

Returns

array|bool Associative array of result row.

Definition at line 2280 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\determineHandlerType(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_assocArray(), TYPO3\CMS\Dbal\Database\DatabaseConnection\map_needMapping(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningADOdbDriver().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_explain().

sql_fetch_row()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_fetch_row

(

$res

)

Returns an array that corresponds to the fetched row, or FALSE if there are no more rows. The array contains the values in numerical indices. MySQLi fetch_row() wrapper function

Parameters

bool | \mysqli_result | object

$res

MySQLi result object / DBAL object

Returns

array|bool Array with result rows.

Definition at line 2350 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\determineHandlerType(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\runningADOdbDriver().

sql_field_metatype()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_field_metatype	(		$table,
			$field
	)

Get the type of the specified field in a result

If the first parameter is a string, it is used as table name for the lookup.

Parameters

string	$table	MySQL result pointer (of SELECT query) / DBAL object / table name
int	$field	Field index. In case of ADOdb a string (field name!)

Returns

string Returns the type of the specified field index

Definition at line 2526 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\INSERTquery(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\UPDATEquery().

sql_field_type()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_field_type	(		$res,
			$pointer
	)

Get the type of the specified field in a result mysql_field_type() wrapper function

Parameters

bool | \mysqli_result | object	$res	MySQLi result object / DBAL object
int	$pointer	Field index.

Returns

string Returns the name of the specified field index, or FALSE on error

Definition at line 2550 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Database\DatabaseConnection\debug(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\determineHandlerType().

sql_free_result()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_free_result

(

$res

)

Free result memory free_result() wrapper function

Parameters

bool | \mysqli_result | object

$res

MySQLi result object / DBAL object

Returns

bool Returns TRUE on success or FALSE on failure.

Definition at line 2405 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\determineHandlerType().

sql_insert_id()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_insert_id

(

)

Get the ID generated from the previous INSERT operation

Returns

int The uid of the last inserted record.

Definition at line 2454 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery().

sql_num_rows()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_num_rows

(

$res

)

Returns the number of selected rows.

Parameters

bool | \mysqli_result | object

$res

MySQLi result object / DBAL object

Returns

int Number of resulting rows

Definition at line 2252 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\determineHandlerType().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery().

sql_pconnect()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_pconnect

(

)

Open a (persistent) connection to a MySQL server

Returns

bool|void

Definition at line 2650 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_init().

sql_query()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_query

(

$query

)

Executes query

EXPERIMENTAL - This method will make its best to handle the query correctly but if it cannot, it will simply pass the query to DEFAULT handler.

You should use exec_* function from this class instead! If you don't, anything that does not use the _DEFAULT handler will probably break!

MySQLi query() wrapper function Beware: Use of this method should be avoided as it is experimentally supported by DBAL. You should consider using exec_SELECTquery() and similar methods instead.

Parameters

string

$query

Query to execute

Returns

bool||object MySQLi result object / DBAL object

Definition at line 2607 of file DatabaseConnection.php.

References $GLOBALS, TYPO3\CMS\Core\Database\DatabaseConnection\connectDB(), TYPO3\CMS\Core\Database\DatabaseConnection\debug(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\isConnected(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\debug_explain().

sql_select_db()

TYPO3\CMS\Dbal\Database\DatabaseConnection::sql_select_db

(

)

Select a SQL database

Returns

bool Returns TRUE on success or FALSE on failure.

Definition at line 2660 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Database\DatabaseConnection\$databaseName, TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey, TYPO3\CMS\Core\Database\DatabaseConnection\admin_get_dbs(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_FATAL.

TRUNCATEquery()

TYPO3\CMS\Core\Database\DatabaseConnection::TRUNCATEquery

(

$table

)

Creates a TRUNCATE TABLE SQL-statement

Parameters

string

$table

See exec_TRUNCATEquery()

Returns

string Full SQL query for TRUNCATE TABLE

Definition at line 1334 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery().

updateLastInsertId()

TYPO3\CMS\Dbal\Database\DatabaseConnection::updateLastInsertId (   $table, array  $fieldValues  )

protected

Update the id information for the last inserted record

Parameters

string	$table
array	$fieldValues

Returns

null|int

Definition at line 2109 of file DatabaseConnection.php.

References TYPO3\CMS\Dbal\Database\DatabaseConnection\$lastHandlerKey.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery().

UPDATEquery()

TYPO3\CMS\Core\Database\DatabaseConnection::UPDATEquery	(		$table,
			$where,
			$fields_values,
			$no_quote_fields = false
	)

Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.

Parameters

string	$table	See exec_UPDATEquery()
string	$where	See exec_UPDATEquery()
array	$fields_values	See exec_UPDATEquery()
bool | array | string	$no_quote_fields	See fullQuoteArray()

Exceptions

Definition at line 1137 of file DatabaseConnection.php.

References TYPO3\CMS\Core\Database\DatabaseConnection\$store_lastBuiltQuery, TYPO3\CMS\Dbal\Database\DatabaseConnection\fullQuoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_getFromTableList(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFieldNames(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteFromTables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteWhereClause(), TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_field_metatype().

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery().

Member Data Documentation

$cache_autoIncFields

TYPO3\CMS\Dbal\Database\DatabaseConnection::$cache_autoIncFields = []

Definition at line 128 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\getCompleteFieldInformation().

$cache_fieldType

TYPO3\CMS\Dbal\Database\DatabaseConnection::$cache_fieldType = []

Definition at line 133 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\getCompleteFieldInformation().

$cache_handlerKeyFromTableList

TYPO3\CMS\Dbal\Database\DatabaseConnection::$cache_handlerKeyFromTableList = []

protected

Definition at line 117 of file DatabaseConnection.php.

$cache_mappingFromTableList

TYPO3\CMS\Dbal\Database\DatabaseConnection::$cache_mappingFromTableList = []

protected

Definition at line 122 of file DatabaseConnection.php.

$cache_primaryKeys

TYPO3\CMS\Dbal\Database\DatabaseConnection::$cache_primaryKeys = []

Definition at line 138 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\getCompleteFieldInformation().

$cacheIdentifier

TYPO3\CMS\Dbal\Database\DatabaseConnection::$cacheIdentifier = 'DatabaseConnection_fieldInfo'

protected

Definition at line 143 of file DatabaseConnection.php.

$conf

TYPO3\CMS\Dbal\Database\DatabaseConnection::$conf = []

Definition at line 39 of file DatabaseConnection.php.

$dbmsSpecifics

TYPO3\CMS\Dbal\Database\DatabaseConnection::$dbmsSpecifics

protected

Definition at line 204 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\getSpecifics().

$debug

TYPO3\CMS\Dbal\Database\DatabaseConnection::$debug = false

Definition at line 33 of file DatabaseConnection.php.

$handlerCfg

TYPO3\CMS\Dbal\Database\DatabaseConnection::$handlerCfg

Initial value:

= [
        '_DEFAULT' => [
            'type' => 'native'

Definition at line 57 of file DatabaseConnection.php.

$handlerInstance

TYPO3\CMS\Dbal\Database\DatabaseConnection::$handlerInstance = []

Definition at line 89 of file DatabaseConnection.php.

$installerSql

TYPO3\CMS\Dbal\Database\DatabaseConnection::$installerSql = null

protected

Definition at line 155 of file DatabaseConnection.php.

$lastHandlerKey

TYPO3\CMS\Dbal\Database\DatabaseConnection::$lastHandlerKey = ''

Definition at line 95 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_get_tables(), TYPO3\CMS\Dbal\Database\DatabaseConnection\admin_query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getMetadata(), TYPO3\CMS\Dbal\Database\DatabaseConnection\getServerVersion(), TYPO3\CMS\Dbal\Database\DatabaseConnection\isConnected(), TYPO3\CMS\Dbal\Database\DatabaseConnection\query(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteName(), TYPO3\CMS\Dbal\Database\DatabaseConnection\quoteStr(), TYPO3\CMS\Dbal\Database\DatabaseConnection\runningNative(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_affected_rows(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_errno(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_error(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_insert_id(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_select_db(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\updateLastInsertId().

$lastParsedAndMappedQueryArray

TYPO3\CMS\Dbal\Database\DatabaseConnection::$lastParsedAndMappedQueryArray = []

protected

Definition at line 107 of file DatabaseConnection.php.

$lastQuery

TYPO3\CMS\Dbal\Database\DatabaseConnection::$lastQuery = ''

protected

Definition at line 101 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\debugHandler().

$mapping

TYPO3\CMS\Dbal\Database\DatabaseConnection::$mapping = []

Definition at line 45 of file DatabaseConnection.php.

Referenced by TYPO3\CMS\Dbal\Database\DatabaseConnection\map_remapSELECTQueryParts(), and TYPO3\CMS\Dbal\Database\DatabaseConnection\map_subquery().

$mysqlDataTypeMapping

TYPO3\CMS\Dbal\Database\DatabaseConnection::$mysqlDataTypeMapping

protected

Initial value:

= [
        MYSQLI_TYPE_TINY => 'tinyint'

Definition at line 171 of file DatabaseConnection.php.

$printErrors

TYPO3\CMS\Dbal\Database\DatabaseConnection::$printErrors = false

protected

Definition at line 27 of file DatabaseConnection.php.

$queryCache

TYPO3\CMS\Dbal\Database\DatabaseConnection::$queryCache

protected

Definition at line 162 of file DatabaseConnection.php.

$resourceIdToTableNameMap

TYPO3\CMS\Dbal\Database\DatabaseConnection::$resourceIdToTableNameMap = []

protected

Definition at line 112 of file DatabaseConnection.php.

$SQLparser

TYPO3\CMS\Dbal\Database\DatabaseConnection::$SQLparser

Definition at line 150 of file DatabaseConnection.php.

$table2handlerKeys

TYPO3\CMS\Dbal\Database\DatabaseConnection::$table2handlerKeys = []

protected

Definition at line 51 of file DatabaseConnection.php.

MYSQLI_TYPE_CHAR

TYPO3\CMS\Dbal\Database\DatabaseConnection::MYSQLI_TYPE_CHAR

Initial value:

=> 'tinyint',
        MYSQLI_TYPE_SHORT => 'smallint',
        MYSQLI_TYPE_LONG => 'int',
        MYSQLI_TYPE_FLOAT => 'float',
        MYSQLI_TYPE_DOUBLE => 'double',
        MYSQLI_TYPE_TIMESTAMP => 'timestamp',
        MYSQLI_TYPE_LONGLONG => 'bigint',
        MYSQLI_TYPE_INT24 => 'mediumint',
        MYSQLI_TYPE_DATE => 'date',
        MYSQLI_TYPE_NEWDATE => 'date',
        MYSQLI_TYPE_TIME => 'time',
        MYSQLI_TYPE_DATETIME => 'datetime',
        MYSQLI_TYPE_YEAR => 'year',
        MYSQLI_TYPE_BIT => 'bit',
        MYSQLI_TYPE_INTERVAL => 'interval',
        MYSQLI_TYPE_ENUM => 'enum',
        MYSQLI_TYPE_SET => 'set',
        MYSQLI_TYPE_TINY_BLOB => 'blob',
        MYSQLI_TYPE_MEDIUM_BLOB => 'blob',
        MYSQLI_TYPE_LONG_BLOB => 'blob',
        MYSQLI_TYPE_BLOB => 'blob',
        MYSQLI_TYPE_VAR_STRING => 'varchar',
        MYSQLI_TYPE_STRING => 'char',
        MYSQLI_TYPE_DECIMAL => 'decimal',
        MYSQLI_TYPE_NEWDECIMAL => 'decimal',
        MYSQLI_TYPE_GEOMETRY => 'geometry'
    ]

Definition at line 173 of file DatabaseConnection.php.