t3lib_DB Class Reference

List of all members.


Public Member Functions
	exec_INSERTquery ($table, $fields_values)
	exec_UPDATEquery ($table, $where, $fields_values)
	exec_DELETEquery ($table, $where)
	exec_SELECTquery ($select_fields, $from_table, $where_clause, $groupBy=', $orderBy=', $limit=')
	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=')
	INSERTquery ($table, $fields_values)
	UPDATEquery ($table, $where, $fields_values)
	DELETEquery ($table, $where)
	SELECTquery ($select_fields, $from_table, $where_clause, $groupBy=', $orderBy=', $limit=')
	listQuery ($field, $value, $table)
	searchQuery ($searchWords, $fields, $table)
	fullQuoteStr ($str, $table)
	quoteStr ($str, $table)
	cleanIntArray ($arr)
	cleanIntList ($list)
	stripOrderBy ($str)
	stripGroupBy ($str)
	splitGroupOrderLimit ($str)
	sql ($db, $query)
	sql_query ($query)
	sql_error ()
	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 ($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password)
	sql_select_db ($TYPO3_db)
	admin_get_dbs ()
	admin_get_tables ()
	admin_get_fields ($tableName)
	admin_get_keys ($tableName)
	admin_query ($query)
	debug ($func)
	exec_INSERTquery ($table, $fields_values)
	exec_UPDATEquery ($table, $where, $fields_values)
	exec_DELETEquery ($table, $where)
	exec_SELECTquery ($select_fields, $from_table, $where_clause, $groupBy=', $orderBy=', $limit=')
	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=')
	INSERTquery ($table, $fields_values)
	UPDATEquery ($table, $where, $fields_values)
	DELETEquery ($table, $where)
	SELECTquery ($select_fields, $from_table, $where_clause, $groupBy=', $orderBy=', $limit=')
	listQuery ($field, $value, $table)
	searchQuery ($searchWords, $fields, $table)
	fullQuoteStr ($str, $table)
	quoteStr ($str, $table)
	cleanIntArray ($arr)
	cleanIntList ($list)
	stripOrderBy ($str)
	stripGroupBy ($str)
	splitGroupOrderLimit ($str)
	sql ($db, $query)
	sql_query ($query)
	sql_error ()
	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 ($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password)
	sql_select_db ($TYPO3_db)
	admin_get_dbs ()
	admin_get_tables ()
	admin_get_fields ($tableName)
	admin_get_keys ($tableName)
	admin_query ($query)
	debug ($func)
Public Attributes
	$debugOutput = FALSE
	$debug_lastBuiltQuery = ''
	$store_lastBuiltQuery = FALSE
	$link

Detailed Description

Definition at line 133 of file class.t3lib_db.php.

Member Function Documentation

t3lib_DB::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! Usage count/core: 1

Returns:
array Each entry represents a database name

Definition at line 872 of file class.t3lib_db.php.
References $row.

t3lib_DB::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 Table name

Returns:
array Field information in an associative array with fieldname => field row

Definition at line 909 of file class.t3lib_db.php.

t3lib_DB::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 Table name

Returns:
array Key information in a numeric array

Definition at line 927 of file class.t3lib_db.php.

t3lib_DB::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 Usage count/core: 2

Returns:
array Tables in an array (tablename is in both key and value)

Definition at line 890 of file class.t3lib_db.php.

t3lib_DB::admin_query ( $ query )

mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database! Usage count/core: 10

Parameters:

string Query to execute

Returns:
pointer Result pointer

Definition at line 945 of file class.t3lib_db.php.
References $res, admin_query(), and debug().

t3lib_DB::cleanIntArray ( $ arr )

Will convert all values in the one-dimentional array to integers. Useful when you want to make sure an array contains only integers before imploding them in a select-list. Usage count/core: 7

Parameters:

array Array with values

Returns:
array The input array with all values passed through intval()

See also:
cleanIntList()

Definition at line 568 of file class.t3lib_db.php.
References $k.

t3lib_DB::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. Usage count/core: 6

Parameters:

string List of comma-separated values which should be integers

Returns:
string The input list but with every value passed through intval()

See also:
cleanIntArray()

Definition at line 584 of file class.t3lib_db.php.
References t3lib_div::intExplode().

t3lib_DB::debug ( $ func )

Debug function: Outputs error if any

Parameters:

string Function calling debug()

Returns:
void

Definition at line 972 of file class.t3lib_db.php.
References sql_error(), and t3lib_div::view_array().
Referenced by admin_query(), exec_DELETEquery(), exec_INSERTquery(), exec_SELECTgetRows(), exec_SELECTquery(), exec_UPDATEquery(), sql(), and sql_query().

t3lib_DB::DELETEquery ( $ table,

$ where

)

Creates a DELETE SQL-statement for $table where $where-clause Usage count/core: 3

Parameters:

string See exec_DELETEquery()

string See exec_DELETEquery()

Returns:
string Full SQL query for DELETE use exec_DELETEquery() instead if possible!

Definition at line 409 of file class.t3lib_db.php.
References $query, a, and WHERE.

t3lib_DB::exec_DELETEquery ( $ table,

$ where

)

Creates and executes a DELETE SQL-statement for $table where $where-clause Usage count/core: 40

Parameters:

string Database tablename

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

Returns:
pointer MySQL result pointer / DBAL object

Definition at line 199 of file class.t3lib_db.php.
References $res, debug(), exec_DELETEquery(), and table.

t3lib_DB::exec_INSERTquery ( $ table,

$ fields_values

)

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 Usage count/core: 47

Parameters:

string Table name

array 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.

Returns:
pointer MySQL result pointer / DBAL object

Definition at line 169 of file class.t3lib_db.php.
References $res, debug(), exec_INSERTquery(), and table.

t3lib_DB::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 $TCA in Inside TYPO3 for more details.
Usage: 12 (spec. ext. sys_action, sys_messages, sys_todos)

Parameters:

string Field list for SELECT

string Tablename, local table

string Tablename, relation table

string Tablename, foreign table

string Optional 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 Optional GROUP BY field(s), if none, supply blank string.

string Optional ORDER BY field(s), if none, supply blank string.

string Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns:
pointer MySQL result pointer / DBAL object

See also:
exec_SELECTquery()

Definition at line 243 of file class.t3lib_db.php.
References $GLOBALS, and select.

t3lib_DB::exec_SELECT_queryArray ( $ queryParts )

Executes a select based on input query parts array
Usage: 9

Parameters:

array Query parts array

Returns:
pointer MySQL select result pointer / DBAL object

See also:
exec_SELECTquery()

Definition at line 266 of file class.t3lib_db.php.
References exec_SELECTquery(), and WHERE.

t3lib_DB::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 See exec_SELECTquery()

string See exec_SELECTquery()

string See exec_SELECTquery()

string See exec_SELECTquery()

string See exec_SELECTquery()

string See exec_SELECTquery()

string If set, the result array will carry this field names value as index. Requires that field to be selected of course!

Returns:
array Array of rows.

Definition at line 289 of file class.t3lib_db.php.
References $res, debug(), exec_SELECTquery(), and sql_fetch_assoc().

t3lib_DB::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. Usage count/core: 340

Parameters:

string List of fields to select from the table. This is what comes right after "SELECT ...". Required value.

string Table(s) from which to select. This is what comes right after "FROM ...". Required value.

string Optional 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 Optional GROUP BY field(s), if none, supply blank string.

string Optional ORDER BY field(s), if none, supply blank string.

string Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns:
pointer MySQL result pointer / DBAL object

Definition at line 218 of file class.t3lib_db.php.
References $res, debug(), and exec_SELECTquery().

t3lib_DB::exec_UPDATEquery ( $ table,

$ where,

$ fields_values

)

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 Usage count/core: 50

Parameters:

string Database tablename

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

array 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.

Returns:
pointer MySQL result pointer / DBAL object

Definition at line 185 of file class.t3lib_db.php.
References $res, debug(), exec_UPDATEquery(), and table.

t3lib_DB::fullQuoteStr ( $ str,

$ table

)

Escaping and quoting values for SQL statements. Usage count/core: 100

Parameters:

string Input string

string 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!).

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 539 of file class.t3lib_db.php.

t3lib_DB::INSERTquery ( $ table,

$ fields_values

)

Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values. Usage count/core: 4

Parameters:

string See exec_INSERTquery()

array See exec_INSERTquery()

Returns:
string Full SQL query for INSERT (unless $fields_values does not contain any elements in which case it will be false) use exec_INSERTquery() instead if possible!

Definition at line 334 of file class.t3lib_db.php.
References $k, $query, fullQuoteStr(), and table.

t3lib_DB::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 positioni in the list (left, middle or right). Is nice to look up list-relations to records or files in TYPO3 database tables.

Parameters:

string Field name

string Value to find in list

string Table in which we are searching (for DBAL detection of quoteStr() method)

Returns:
string WHERE clause for a query

Definition at line 479 of file class.t3lib_db.php.
References quoteStr(), table, and value.

t3lib_DB::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()!
Usage count/core: 20

Parameters:

string Input string

string 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!).

Returns:
string Output string; Quotes (" / ') and \ will be backslashed (or otherwise based on DBAL handler)

See also:
quoteStr()

Definition at line 555 of file class.t3lib_db.php.

t3lib_DB::searchQuery ( $ searchWords,

$ fields,

$ table

)

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

Parameters:

array Array of search words

array Array of fields

string Table in which we are searching (for DBAL detection of quoteStr() method)

Returns:
string WHERE clause for search

Definition at line 493 of file class.t3lib_db.php.
References $query, $table, and table.

t3lib_DB::SELECTquery ( $ select_fields,

$ from_table,

$ where_clause,

$ groupBy = ',

$ orderBy = ',

$ limit = '

)

Creates a SELECT SQL-statement Usage count/core: 11

Parameters:

string See exec_SELECTquery()

string See exec_SELECTquery()

string See exec_SELECTquery()

string See

t3lib_DB Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation