TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
DatabaseConnection Class Reference

Public Member Functions

 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)
 
 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_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

const AND_Constraint = 'AND'
 
const OR_Constraint = 'OR'
 
 $debugOutput = false
 
 $debug_lastBuiltQuery = ''
 
 $store_lastBuiltQuery = false
 
 $explainOutput = 0
 
 $default_charset = 'utf8'
 

Protected Member Functions

 query ($query)
 
 getSelectMmQueryParts ($select, $local_table, $mm_table, $foreign_table, $whereClause= '', $groupBy= '', $orderBy= '', $limit= '')
 
 checkConnectionCharset ()
 
 disconnectIfConnected ()
 
 logDeprecation ()
 

Protected Attributes

 $databaseHost = ''
 
 $databasePort = 3306
 
 $databaseSocket = null
 
 $databaseName = ''
 
 $databaseUsername = ''
 
 $databaseUserPassword = ''
 
 $persistentDatabaseConnection = false
 
 $connectionCompression = false
 
 $connectionCharset = 'utf8'
 
 $initializeCommandsAfterConnect = []
 
 $isConnected = false
 
 $link = null
 
 $preProcessHookObjects = []
 
 $postProcessHookObjects = []
 
 $deprecationWarningThrown = false
 

Detailed Description

Deprecated:

----------— THE WHOLE CLASS WILL BE REMOVED IN TYPO3 v9 -------------------------------------------—

DatabaseConnection a.k.a. TYPO3_DB has been superseded by Doctrine DBAL in TYPO3 v8, and will be removed in TYPO3 v9

Contains the class "DatabaseConnection" containing functions for building SQL queries and mysqli wrappers, thus providing a foundational API to all database interaction. This class is instantiated globally as $TYPO3_DB in TYPO3 scripts.

TYPO3 "database wrapper" class (new in 3.6.0) This class contains

  • abstraction functions for executing INSERT/UPDATE/DELETE/SELECT queries ("Query execution"; These are REQUIRED for all future connectivity to the database, thus ensuring DBAL compliance!)
  • functions for building SQL queries (INSERT/UPDATE/DELETE/SELECT) ("Query building"); These are transitional functions for building SQL queries in a more automated way. Use these to build queries instead of doing it manually in your code!
  • mysqli wrapper functions; These are transitional functions. By a simple search/replace you should be able to substitute all mysql*() calls with $GLOBALS['TYPO3_DB']->sql*() and your application will work out of the box. YOU CANNOT (legally) use any mysqli functions not found as wrapper functions in this class! See the Project Coding Guidelines (doc_core_cgl) for more instructions on best-practise

This class is not in itself a complete database abstraction layer but can be extended to be a DBAL (by extensions, see "dbal" for example) ALL connectivity to the database in TYPO3 must be done through this class! The points of this class are:

  • To direct all database calls through this class so it becomes possible to implement DBAL with extensions.
  • To keep it very easy to use for developers used to MySQL in PHP - and preserve as much performance as possible when TYPO3 is used with MySQL directly...
  • To create an interface for DBAL implemented by extensions; (Eg. making possible escaping characters, clob/blob handling, reserved words handling)
  • Benchmarking the DB bottleneck queries will become much easier; Will make it easier to find optimization possibilities.

USE: In all TYPO3 scripts the global variable $TYPO3_DB is an instance of this class. Use that. Eg. $GLOBALS['TYPO3_DB']->sql_fetch_assoc()

Definition at line 50 of file DatabaseConnection.php.

Member Function Documentation

__sleep ( )

Serialize destructs current connection

Returns
array All protected properties that should be saved

Definition at line 1998 of file DatabaseConnection.php.

admin_get_charsets ( )

Returns information about the character sets supported by the current DBM This function is important not only for the Install Tool but probably for DBALs as well since they might need to look up table specific information in order to construct correct queries. In such cases this information should probably be cached for quick delivery.

This is used by the Install Tool to convert tables with non-UTF8 charsets Use in Install Tool only!

Returns
array Array with Charset as key and an array of "Charset", "Description", "Default collation", "Maxlen" as values

Definition at line 1483 of file DatabaseConnection.php.

admin_get_dbs ( )

Listing databases from current MySQL connection. NOTICE: It WILL try to select those databases and thus break selection of current database. This is only used as a service function in the (1-2-3 process) of the Install Tool. In any case a lookup should be done in the _DEFAULT handler DBMS then. Use in Install Tool only!

Returns
array Each entry represents a database name
Exceptions
RuntimeException

Definition at line 1377 of file DatabaseConnection.php.

admin_get_fields (   $tableName)

Returns information about each field in the $table (quering the DBMS) In a DBAL this should look up the right handler for the table and return compatible information This function is important not only for the Install Tool but probably for DBALs as well since they might need to look up table specific information in order to construct correct queries. In such cases this information should probably be cached for quick delivery.

Parameters
string$tableNameTable name
Returns
array Field information in an associative array with fieldname => field row

Definition at line 1436 of file DatabaseConnection.php.

admin_get_keys (   $tableName)

Returns information about each index key in the $table (quering the DBMS) In a DBAL this should look up the right handler for the table and return compatible information

Parameters
string$tableNameTable name
Returns
array Key information in a numeric array

Definition at line 1457 of file DatabaseConnection.php.

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 1411 of file DatabaseConnection.php.

admin_query (   $query)

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

Parameters
string$queryQuery to execute
Returns
bool||object MySQLi result object / DBAL object

Definition at line 1503 of file DatabaseConnection.php.

References debug().

checkConnectionCharset ( )
protected

Checks if the current connection character set has the same value as the connectionCharset variable.

To determine the character set these MySQL session variables are checked: character_set_client, character_set_results and character_set_connection.

If the character set does not match or if the session variables can not be read a RuntimeException is thrown.

Returns
void
Exceptions
RuntimeException

Definition at line 1725 of file DatabaseConnection.php.

References $GLOBALS, and GeneralUtility\SYSLOG_SEVERITY_ERROR.

cleanIntArray (   $arr)

Will convert all values in the one-dimensional array to integers. Useful when you want to make sure an array contains only integers before imploding them in a select-list.

Parameters
array$arrArray with values
Returns
array The input array with all values cast to (int)
See also
cleanIntList()

Definition at line 961 of file DatabaseConnection.php.

cleanIntList (   $list)

Will force all entries in the input comma list to integers Useful when you want to make sure a commalist of supposed integers really contain only integers; You want to know that when you don't trust content that could go into an SQL statement.

Parameters
string$listList of comma-separated values which should be integers
Returns
string The input list but with every value cast to (int)
See also
cleanIntArray()

Definition at line 975 of file DatabaseConnection.php.

References GeneralUtility\intExplode().

connectDB ( )

Connects to database for TYPO3 sites:

Exceptions
RuntimeException
UnexpectedValueException
Returns
void

Definition at line 1641 of file DatabaseConnection.php.

References $GLOBALS, and GeneralUtility\getUserObj().

Referenced by DatabaseConnection\query().

debug (   $func,
  $query = '' 
)

Debug function: Outputs error if any

Parameters
string$funcFunction calling debug()
string$queryLast query if not last built query
Returns
void

Definition at line 1845 of file DatabaseConnection.php.

References $GLOBALS, DebugUtility\debug(), and DebugUtility\debugTrail().

debug_check_recordset (   $res)

Checks if record set is valid and writes debugging information into devLog if not.

Parameters
bool|mysqli_result|object MySQLi result object / DBAL object
Returns
bool TRUE if the record set is valid, FALSE otherwise

Definition at line 1871 of file DatabaseConnection.php.

References GeneralUtility\devLog(), and GeneralUtility\SYSLOG_SEVERITY_ERROR.

disconnectIfConnected ( )
protected

Disconnect from database if connected

Returns
void

Definition at line 1793 of file DatabaseConnection.php.

escapeStrForLike (   $str,
  $table 
)

Escaping values for SQL LIKE statements.

Parameters
string$strInput string
string$tableTable name for which to escape 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!).
Returns
string Output string; % and _ will be escaped with \ (or otherwise based on DBAL handler)
See also
quoteStr()

Definition at line 947 of file DatabaseConnection.php.

exec_SELECT_mm_query (   $select,
  $local_table,
  $mm_table,
  $foreign_table,
  $whereClause = '',
  $groupBy = '',
  $orderBy = '',
  $limit = '' 
)

Creates and executes a SELECT query, selecting fields ($select) from two/three tables joined Use $mm_table together with $local_table or $foreign_table to select over two tables. Or use all three tables to select the full MM-relation. The JOIN is done with [$local_table].uid <–> [$mm_table].uid_local / [$mm_table].uid_foreign <–> [$foreign_table].uid The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $GLOBALS['TCA'] in Inside TYPO3 for more details.

Parameters
string$selectField list for SELECT
string$local_tableTablename, local table
string$mm_tableTablename, relation table
string$foreign_tableTablename, foreign table
string$whereClauseOptional 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! You have to prepend 'AND ' to this parameter yourself!
string$groupByOptional GROUP BY field(s), if none, supply blank string.
string$orderByOptional ORDER BY field(s), if none, supply blank string.
string$limitOptional LIMIT value ([begin,]max), if none, supply blank string.
Returns
bool||object MySQLi result object / DBAL object
See also
exec_SELECTquery()

Definition at line 344 of file DatabaseConnection.php.

References DatabaseConnection\exec_SELECT_queryArray(), DatabaseConnection\getSelectMmQueryParts(), and DatabaseConnection\logDeprecation().

exec_SELECT_queryArray (   $queryParts)

Executes a select based on input query parts array

Parameters
array$queryPartsQuery parts array
Returns
bool||object MySQLi result object / DBAL object
See also
exec_SELECTquery()

Definition at line 358 of file DatabaseConnection.php.

References DatabaseConnection\logDeprecation().

Referenced by DatabaseConnection\exec_SELECT_mm_query().

exec_SELECTcountRows (   $field,
  $table,
  $where = '1=1' 
)

Counts the number of rows in a table.

Parameters
string$fieldName of the field to use in the COUNT() expression (e.g. '*')
string$tableName of the table to count rows for
string$where(optional) WHERE statement of the query
Returns
mixed Number of rows counter (int) or FALSE if something went wrong (bool)

Definition at line 442 of file DatabaseConnection.php.

References DatabaseConnection\logDeprecation(), DatabaseConnection\sql_fetch_row(), and DatabaseConnection\sql_free_result().

exec_SELECTgetRows (   $select_fields,
  $from_table,
  $where_clause,
  $groupBy = '',
  $orderBy = '',
  $limit = '',
  $uidIndexField = '' 
)

Creates and executes a SELECT SQL-statement AND traverse result set and returns array with records in.

Parameters
string$select_fieldsList of fields to select from the table. This is what comes right after "SELECT ...". Required value.
string$from_tableTable(s) from which to select. This is what comes right after "FROM ...". Required value.
string$where_clauseAdditional 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$groupByOptional GROUP BY field(s), if none, supply blank string.
string$orderByOptional ORDER BY field(s), if none, supply blank string.
string$limitOptional LIMIT value ([begin,]max), if none, supply blank string.
string$uidIndexFieldIf set, the result array will carry this field names value as index. Requires that field to be selected of course!
Returns
array|NULL Array of rows, or NULL in case of SQL error
See also
exec_SELECTquery()
Exceptions
InvalidArgumentException

Definition at line 378 of file DatabaseConnection.php.

References DatabaseConnection\logDeprecation(), DatabaseConnection\sql_error(), DatabaseConnection\sql_fetch_assoc(), and DatabaseConnection\sql_free_result().

exec_SELECTgetSingleRow (   $select_fields,
  $from_table,
  $where_clause,
  $groupBy = '',
  $orderBy = '',
  $numIndex = false 
)

Creates and executes a SELECT SQL-statement AND gets a result set and returns an array with a single record in. LIMIT is automatically set to 1 and can not be overridden.

Parameters
string$select_fieldsList of fields to select from the table.
string$from_tableTable(s) from which to select.
string$where_clauseOptional additional WHERE clauses put in the end of the query. NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
string$groupByOptional GROUP BY field(s), if none, supply blank string.
string$orderByOptional ORDER BY field(s), if none, supply blank string.
bool$numIndexIf set, the result will be fetched with sql_fetch_row, otherwise sql_fetch_assoc will be used.
Returns
array|FALSE|NULL Single row, FALSE on empty result, NULL on error

Definition at line 418 of file DatabaseConnection.php.

References DatabaseConnection\logDeprecation(), DatabaseConnection\sql_fetch_assoc(), DatabaseConnection\sql_fetch_row(), and DatabaseConnection\sql_free_result().

fullQuoteArray (   $arr,
  $table,
  $noQuote = false,
  $allowNull = false 
)

Will fullquote all values in the one-dimensional array so they are ready to "implode" for an sql query.

Parameters
array$arrArray with values (either associative or non-associative array)
string$tableTable name for which to quote
bool | array | string$noQuoteList/array of keys NOT to quote (eg. SQL functions) - ONLY for associative arrays
bool$allowNullWhether to allow NULL values
Returns
array The input array with the values quoted
See also
cleanIntArray()

Definition at line 901 of file DatabaseConnection.php.

Referenced by DatabaseConnection\INSERTquery().

fullQuoteStr (   $str,
  $table,
  $allowNull = false 
)

Escaping and quoting values for SQL statements.

Parameters
string$strInput string
string$tableTable 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$allowNullWhether 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 875 of file DatabaseConnection.php.

getDatabaseHandle ( )

Returns current database handle

Returns
|NULL

Definition at line 1806 of file DatabaseConnection.php.

getDateTimeFormats (   $table)

Returns the date and time formats compatible with the given database table.

Parameters
string$tableTable name for which to return an empty date. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how date and time should be formatted).
Returns
array

Definition at line 1017 of file DatabaseConnection.php.

References QueryHelper\getDateTimeFormats().

getSelectMmQueryParts (   $select,
  $local_table,
  $mm_table,
  $foreign_table,
  $whereClause = '',
  $groupBy = '',
  $orderBy = '',
  $limit = '' 
)
protected

Creates SELECT query components for selecting fields ($select) from two/three tables joined Use $mm_table together with $local_table or $foreign_table to select over two tables. Or use all three tables to select the full MM-relation. The JOIN is done with [$local_table].uid <–> [$mm_table].uid_local / [$mm_table].uid_foreign <–> [$foreign_table].uid The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $GLOBALS['TCA'] in Inside TYPO3 for more details.

Parameters
string$selectSee exec_SELECT_mm_query()
string$local_tableSee exec_SELECT_mm_query()
string$mm_tableSee exec_SELECT_mm_query()
string$foreign_tableSee exec_SELECT_mm_query()
string$whereClauseSee exec_SELECT_mm_query()
string$groupBySee exec_SELECT_mm_query()
string$orderBySee exec_SELECT_mm_query()
string$limitSee exec_SELECT_mm_query()
Returns
array SQL query components

Definition at line 1039 of file DatabaseConnection.php.

References StringUtility\getUniqueId().

Referenced by DatabaseConnection\exec_SELECT_mm_query(), and DatabaseConnection\SELECT_mm_query().

getServerVersion ( )

Get the MySQL server version

Returns
string

Definition at line 1827 of file DatabaseConnection.php.

initialize ( )

Initialize the database connection

Returns
void

Definition at line 188 of file DatabaseConnection.php.

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$tableSee exec_INSERTquery()
array$fields_valuesSee exec_INSERTquery()
bool | array | string$no_quote_fieldsSee fullQuoteArray()
Returns
string|NULL Full SQL query for INSERT, NULL if $fields_values is empty

Definition at line 504 of file DatabaseConnection.php.

References DatabaseConnection\fullQuoteArray(), and DatabaseConnection\logDeprecation().

isConnected ( )

Checks if database is connected

Returns
bool

Definition at line 1700 of file DatabaseConnection.php.

Referenced by DatabaseConnection\query().

listQuery (   $field,
  $value,
  $table 
)

Returns a WHERE clause that can find a value ($value) in a list field ($field) For instance a record in the database might contain a list of numbers, "34,234,5" (with no spaces between). This query would be able to select that record based on the value "34", "234" or "5" regardless of their position in the list (left, middle or right). The value must not contain a comma (,) Is nice to look up list-relations to records or files in TYPO3 database tables.

Parameters
string$fieldField name
string$valueValue to find in list
string$tableTable in which we are searching (for DBAL detection of quoteStr() method)
Returns
string WHERE clause for a query
Exceptions
InvalidArgumentException

Definition at line 748 of file DatabaseConnection.php.

References DatabaseConnection\logDeprecation(), and DatabaseConnection\quoteStr().

prepare_PREPAREDquery (   $query,
array  $queryComponents 
)

Prepares a prepared query.

Parameters
string$queryThe query to execute
array$queryComponentsThe components of the query to execute
Returns
|object MySQLi statement / DBAL object

Definition at line 842 of file DatabaseConnection.php.

References debug().

prepare_SELECTqueryArray ( array  $queryParts,
array  $input_parameters = [] 
)

Creates a SELECT prepared SQL statement based on input query parts array

Parameters
array$queryPartsQuery parts array
array$input_parametersAn 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 828 of file DatabaseConnection.php.

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$queryThe query to send to the database
Returns
bool|

Definition at line 482 of file DatabaseConnection.php.

References DatabaseConnection\connectDB(), DatabaseConnection\isConnected(), and DatabaseConnection\logDeprecation().

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$strInput string
string$tableTable 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!).
Returns
string Output string; Quotes (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
See also
quoteStr()

Definition at line 930 of file DatabaseConnection.php.

Referenced by DatabaseConnection\listQuery().

searchQuery (   $searchWords,
  $fields,
  $table,
  $constraint = self::AND_Constraint 
)

Returns a WHERE clause which will make an AND or OR search for the words in the $searchWords array in any of the fields in array $fields.

Parameters
array$searchWordsArray of search words
array$fieldsArray of fields
string$tableTable in which we are searching (for DBAL detection of quoteStr() method)
string$constraintHow multiple search words have to match ('AND' or 'OR')
Returns
string WHERE clause for search

Definition at line 769 of file DatabaseConnection.php.

SELECT_mm_query (   $select,
  $local_table,
  $mm_table,
  $foreign_table,
  $whereClause = '',
  $groupBy = '',
  $orderBy = '',
  $limit = '' 
)

Creates a SELECT query, selecting fields ($select) from two/three tables joined Use $mm_table together with $local_table or $foreign_table to select over two tables. Or use all three tables to select the full MM-relation. The JOIN is done with [$local_table].uid <–> [$mm_table].uid_local / [$mm_table].uid_foreign <–> [$foreign_table].uid The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $GLOBALS['TCA'] in Inside TYPO3 for more details.

Parameters
string$selectSee exec_SELECT_mm_query()
string$local_tableSee exec_SELECT_mm_query()
string$mm_tableSee exec_SELECT_mm_query()
string$foreign_tableSee exec_SELECT_mm_query()
string$whereClauseSee exec_SELECT_mm_query()
string$groupBySee exec_SELECT_mm_query()
string$orderBySee exec_SELECT_mm_query()
string$limitSee exec_SELECT_mm_query()
Returns
string Full SQL query for SELECT
See also
SELECTquery()

Definition at line 703 of file DatabaseConnection.php.

References DatabaseConnection\getSelectMmQueryParts(), and DatabaseConnection\logDeprecation().

SELECTsubquery (   $select_fields,
  $from_table,
  $where_clause 
)

Creates a SELECT SQL-statement to be used as subquery within another query. BEWARE: This method should not be overriden within DBAL to prevent quoting from happening.

Parameters
string$select_fieldsList of fields to select from the table.
string$from_tableTable from which to select.
string$where_clauseConditional WHERE statement
Returns
string Full SQL query for SELECT

Definition at line 673 of file DatabaseConnection.php.

References DatabaseConnection\logDeprecation().

setConnectionCharset (   $connectionCharset = 'utf8')

Set the charset that should be used for the MySQL connection. The given value will be passed on to mysqli_set_charset().

The default value of this setting is utf8.

Parameters
string$connectionCharsetThe connection charset that will be passed on to mysqli_set_charset() when connecting the database. Default is utf8.
Returns
void

Definition at line 1628 of file DatabaseConnection.php.

setConnectionCompression (   $connectionCompression)

Set connection compression. Might be an advantage, if SQL server is not on localhost

Parameters
bool$connectionCompressionTRUE if connection should be compressed

Definition at line 1602 of file DatabaseConnection.php.

setDatabaseHandle (   $handle)

Set current database handle, usually

Parameters
\mysqli$handle

Definition at line 1817 of file DatabaseConnection.php.

setDatabaseHost (   $host = 'localhost')

Set database host

Parameters
string$host

Definition at line 1524 of file DatabaseConnection.php.

setDatabaseName (   $name)

Set database name

Parameters
string$name

Definition at line 1557 of file DatabaseConnection.php.

setDatabasePassword (   $password)

Set database password

Parameters
string$password

Definition at line 1579 of file DatabaseConnection.php.

setDatabasePort (   $port = 3306)

Set database port

Parameters
int$port

Definition at line 1535 of file DatabaseConnection.php.

setDatabaseSocket (   $socket = null)

Set database socket

Parameters
string | NULL$socket

Definition at line 1546 of file DatabaseConnection.php.

setDatabaseUsername (   $username)

Set database username

Parameters
string$username

Definition at line 1568 of file DatabaseConnection.php.

setInitializeCommandsAfterConnect ( array  $commands)

Set commands to be fired after connection was established

Parameters
array$commandsList of SQL commands to be executed after connect

Definition at line 1613 of file DatabaseConnection.php.

setPersistentDatabaseConnection (   $persistentDatabaseConnection)

Set persistent database connection

Parameters
bool$persistentDatabaseConnection
See also
http://php.net/manual/de/mysqli.persistconns.php

Definition at line 1591 of file DatabaseConnection.php.

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 1201 of file DatabaseConnection.php.

sql_data_seek (   $res,
  $seek 
)

Move internal result pointer

Parameters
bool | \mysqli_result | object$resMySQLi result object / DBAL object
int$seekSeek result number.
Returns
bool Returns TRUE on success or FALSE on failure.

Definition at line 1213 of file DatabaseConnection.php.

sql_errno ( )

Returns the error number on the last query() execution

Returns
int MySQLi error number

Definition at line 1100 of file DatabaseConnection.php.

sql_error ( )

Returns the error status on the last query() execution

Returns
string MySQLi error string.

Definition at line 1089 of file DatabaseConnection.php.

Referenced by DatabaseConnection\exec_SELECTgetRows().

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$resMySQLi result object / DBAL object
Returns
array|bool Associative array of result row.

Definition at line 1129 of file DatabaseConnection.php.

Referenced by DatabaseConnection\exec_SELECTgetRows(), and DatabaseConnection\exec_SELECTgetSingleRow().

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$resMySQLi result object / DBAL object
Returns
array|bool Array with result rows.

Definition at line 1152 of file DatabaseConnection.php.

Referenced by DatabaseConnection\exec_SELECTcountRows(), and DatabaseConnection\exec_SELECTgetSingleRow().

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$resMySQLi result object / DBAL object
int$pointerField index.
Returns
string Returns the name of the specified field index, or FALSE on error

Definition at line 1231 of file DatabaseConnection.php.

sql_free_result (   $res)

Free result memory free_result() wrapper function

Parameters
bool | \mysqli_result | object$resMySQLi result object / DBAL object
Returns
bool Returns TRUE on success or FALSE on failure.

Definition at line 1174 of file DatabaseConnection.php.

Referenced by DatabaseConnection\exec_SELECTcountRows(), DatabaseConnection\exec_SELECTgetRows(), and DatabaseConnection\exec_SELECTgetSingleRow().

sql_insert_id ( )

Get the ID generated from the previous INSERT operation

Returns
int The uid of the last inserted record.

Definition at line 1190 of file DatabaseConnection.php.

sql_num_rows (   $res)

Returns the number of selected rows.

Parameters
bool | \mysqli_result | object$resMySQLi result object / DBAL object
Returns
int Number of resulting rows

Definition at line 1112 of file DatabaseConnection.php.

sql_query (   $query)

Executes query 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$queryQuery to execute
Returns
bool||object MySQLi result object / DBAL object

Definition at line 1074 of file DatabaseConnection.php.

References debug().

sql_select_db ( )

Select a SQL database

Returns
bool Returns TRUE on success or FALSE on failure.

Definition at line 1345 of file DatabaseConnection.php.

References GeneralUtility\SYSLOG_SEVERITY_FATAL.

stripGroupBy (   $str)

Removes the prefix "GROUP BY" from the input string. This function is used when you call the SELECTquery() function and want to pass the GROUP BY parameter by can't guarantee that "GROUP BY" is not prefixed. Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.

Parameters
string$streg. "GROUP BY title, uid @return string eg. "title, uid
See also
exec_SELECTquery(), stripOrderBy()

Definition at line 1005 of file DatabaseConnection.php.

stripOrderBy (   $str)

Removes the prefix "ORDER BY" from the input string. This function is used when you call the exec_SELECTquery() function and want to pass the ORDER BY parameter by can't guarantee that "ORDER BY" is not prefixed. Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.

Parameters
string$streg. "ORDER BY title, uid @return string eg. "title, uid
See also
exec_SELECTquery(), stripGroupBy()

Definition at line 990 of file DatabaseConnection.php.

Member Data Documentation

$connectionCharset = 'utf8'
protected

Definition at line 142 of file DatabaseConnection.php.

$connectionCompression = false
protected

Definition at line 134 of file DatabaseConnection.php.

$databaseHost = ''
protected

Definition at line 98 of file DatabaseConnection.php.

$databaseName = ''
protected

Definition at line 113 of file DatabaseConnection.php.

$databasePort = 3306
protected

Definition at line 103 of file DatabaseConnection.php.

$databaseSocket = null
protected

Definition at line 108 of file DatabaseConnection.php.

$databaseUsername = ''
protected

Definition at line 118 of file DatabaseConnection.php.

$databaseUserPassword = ''
protected

Definition at line 123 of file DatabaseConnection.php.

$debug_lastBuiltQuery = ''

Definition at line 78 of file DatabaseConnection.php.

$debugOutput = false

Definition at line 71 of file DatabaseConnection.php.

$default_charset = 'utf8'

Definition at line 164 of file DatabaseConnection.php.

$deprecationWarningThrown = false
protected

Definition at line 181 of file DatabaseConnection.php.

$explainOutput = 0

Definition at line 93 of file DatabaseConnection.php.

$initializeCommandsAfterConnect = []
protected

Definition at line 147 of file DatabaseConnection.php.

$isConnected = false
protected

Definition at line 152 of file DatabaseConnection.php.

$link = null
protected

Definition at line 157 of file DatabaseConnection.php.

$persistentDatabaseConnection = false
protected

Definition at line 129 of file DatabaseConnection.php.

$postProcessHookObjects = []
protected

Definition at line 174 of file DatabaseConnection.php.

$preProcessHookObjects = []
protected

Definition at line 169 of file DatabaseConnection.php.

$store_lastBuiltQuery = false

Definition at line 85 of file DatabaseConnection.php.

const AND_Constraint = 'AND'

Definition at line 57 of file DatabaseConnection.php.

const OR_Constraint = 'OR'

Definition at line 64 of file DatabaseConnection.php.