Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0  3.8.1  4.0.0  4.0.1  4.1.0   <- Available in other TYPO3 versions

t3lib_sqlengine Class Reference

Inheritance diagram for t3lib_sqlengine:

[legend]Collaboration diagram for t3lib_sqlengine:

[legend]List of all members.

Public Member Functions
	init ($config, &$pObj)
	resetStatusVars ()
	processAccordingToConfig (&$value, $fInfo)
	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)
	sql_query ($query)
	sql_error ()
	sql_insert_id ()
	sql_affected_rows ()
	quoteStr ($str)
	admin_get_tables ()
	admin_get_fields ($tableName)
	admin_get_keys ($tableName)
	admin_query ($query)
	readDataSource ($table)
	saveDataSource ($table)
	selectFromData ($table, $where)
	select_evalSingle ($table, $config, &$itemKeys)
	getResultSet ($keys, $table, $fieldList)
	debug_printResultSet ($array)
Public Attributes
	$data = array()
	$errorStatus = ''
	$lastInsertedId = 0
	$lastAffectedRows = 0

---

Detailed Description

Definition at line 104 of file class.t3lib_sqlengine.php.

---

Member Function Documentation

t3lib_sqlengine::admin_get_fields (  $  tableName  )

(DUMMY) Returns information about each field in the $table Parameters: string  Table name Returns: array Field information in an associative array with fieldname => field row Reimplemented in tx_dbal_handler_openoffice, tx_dbal_handler_rawmysql, and tx_dbal_handler_xmldb. Definition at line 501 of file class.t3lib_sqlengine.php. Referenced by exec_INSERTquery(), and exec_UPDATEquery().

t3lib_sqlengine::admin_get_keys (  $  tableName  )

(DUMMY) Returns information about each index key in the $table Parameters: string  Table name Returns: array Key information in a numeric array Reimplemented in tx_dbal_handler_openoffice, tx_dbal_handler_rawmysql, and tx_dbal_handler_xmldb. Definition at line 512 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::admin_get_tables (   )

(DUMMY) Returns the list of tables from the database Returns: array Tables in an array (tablename is in both key and value) Reimplemented in tx_dbal_handler_openoffice, tx_dbal_handler_rawmysql, and tx_dbal_handler_xmldb. Definition at line 490 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::admin_query (  $  query  )

(DUMMY) mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database! Parameters: string  Query to execute Returns: pointer Result pointer Reimplemented in tx_dbal_handler_openoffice, tx_dbal_handler_rawmysql, and tx_dbal_handler_xmldb. Definition at line 523 of file class.t3lib_sqlengine.php. References sql_query().

t3lib_sqlengine::debug_printResultSet (  $  array  )

Returns the result set (in array) as HTML table. For debugging. Parameters: array  Result set array (array of rows) Returns: string HTML table Definition at line 790 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::exec_DELETEquery (  $  table, $  where )

Execute DELETE query Parameters: string  Table to delete from string  WHERE clause Returns: boolean TRUE on success and FALSE on failure (error is set internally) Reimplemented in tx_dbal_handler_rawmysql. Definition at line 332 of file class.t3lib_sqlengine.php. References t3lib_sqlparser::parseWhereClause(), readDataSource(), resetStatusVars(), saveDataSource(), and selectFromData().

t3lib_sqlengine::exec_INSERTquery (  $  table, $  fields_values )

Execute an INSERT query Parameters: string  Table name array  Field values as key=>value pairs. Returns: boolean TRUE on success and FALSE on failure (error is set internally) Reimplemented in tx_dbal_handler_rawmysql. Definition at line 205 of file class.t3lib_sqlengine.php. References admin_get_fields(), processAccordingToConfig(), readDataSource(), resetStatusVars(), and saveDataSource().

t3lib_sqlengine::exec_SELECTquery (  $  select_fields, $  from_table, $  where_clause, $  groupBy, $  orderBy, $  limit )

Execute SELECT query 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: object Returns result object, but if errors, returns false Reimplemented in tx_dbal_handler_rawmysql. Definition at line 383 of file class.t3lib_sqlengine.php. References getResultSet(), t3lib_div::makeInstance(), t3lib_sqlparser::parseFromTables(), t3lib_sqlparser::parseWhereClause(), readDataSource(), resetStatusVars(), and selectFromData().

t3lib_sqlengine::exec_UPDATEquery (  $  table, $  where, $  fields_values )

Execute UPDATE query on table Parameters: string  Table name string  WHERE clause array  Field values as key=>value pairs. Returns: boolean TRUE on success and FALSE on failure (error is set internally) Reimplemented in tx_dbal_handler_rawmysql. Definition at line 273 of file class.t3lib_sqlengine.php. References admin_get_fields(), t3lib_sqlparser::parseWhereClause(), processAccordingToConfig(), readDataSource(), resetStatusVars(), saveDataSource(), and selectFromData().

t3lib_sqlengine::getResultSet (  $  keys, $  table, $  fieldList )

Returning result set based on result keys, table and field list Parameters: array  Result keys string  Tablename string  Fieldlist (commaseparated) Returns: array Result array with "rows" Definition at line 747 of file class.t3lib_sqlengine.php. References t3lib_div::trimExplode(). Referenced by exec_SELECTquery().

t3lib_sqlengine::init (  $  config, &$  pObj )

Dummy function for initializing SQL handler. Create you own in derived classes. Parameters: array  Configuration array from handler object  Parent object Returns: void Reimplemented in tx_dbal_handler_openoffice, tx_dbal_handler_rawmysql, and tx_dbal_handler_xmldb. Definition at line 126 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::processAccordingToConfig (  &$  value, $  fInfo )

Processing of update/insert values based on field type. The input value is typecast and trimmed/shortened according to the field type and the configuration options from the $fInfo parameter. Parameters: mixed  $value The input value to process array  $fInfo Field configuration data Returns: mixed The processed input value Definition at line 150 of file class.t3lib_sqlengine.php. References t3lib_div::intInRange(), and t3lib_sqlparser::parseFieldDef(). Referenced by exec_INSERTquery(), and exec_UPDATEquery().

t3lib_sqlengine::quoteStr (  $  str  )

Quoting strings for insertion in SQL queries Parameters: string  Input String Returns: string String, with quotes escaped Reimplemented in tx_dbal_handler_rawmysql. Definition at line 465 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::readDataSource (  $  table  )

Dummy function for setting table data. Create your own. NOTICE: Handler to "table-locking" needs to be made probably! Parameters: string  Table name Returns: void Todo: Table locking tools? Reimplemented in tx_dbal_handler_openoffice, and tx_dbal_handler_xmldb. Definition at line 548 of file class.t3lib_sqlengine.php. Referenced by exec_DELETEquery(), exec_INSERTquery(), exec_SELECTquery(), and exec_UPDATEquery().

t3lib_sqlengine::resetStatusVars (   )

Reset SQL engine status variables (insert id, affected rows, error status) Returns: void Definition at line 134 of file class.t3lib_sqlengine.php. Referenced by exec_DELETEquery(), exec_INSERTquery(), exec_SELECTquery(), and exec_UPDATEquery().

t3lib_sqlengine::saveDataSource (  $  table  )

Dummy function for setting table data. Create your own. NOTICE: Handler to "table-locking" needs to be made probably! Parameters: string  Table name Returns: void Todo: Table locking tools? Reimplemented in tx_dbal_handler_openoffice, and tx_dbal_handler_xmldb. Definition at line 560 of file class.t3lib_sqlengine.php. Referenced by exec_DELETEquery(), exec_INSERTquery(), and exec_UPDATEquery().

t3lib_sqlengine::select_evalSingle (  $  table, $  config, &$  itemKeys )

Evalutaion of a WHERE-clause-array. Yet EXPERIMENTAL Parameters: string  Tablename array  WHERE-configuration array array  Data array to work on. Returns: void Data array passed by reference See also: selectFromData() Definition at line 628 of file class.t3lib_sqlengine.php. References selectFromData(). Referenced by selectFromData().

t3lib_sqlengine::selectFromData (  $  table, $  where )

PHP simulation of SQL "SELECT" Yet EXPERIMENTAL! Parameters: string  Table name array  Where clause parsed into array Returns: array Array of keys pointing to result rows in $this->data[$table] Definition at line 590 of file class.t3lib_sqlengine.php. References select_evalSingle(). Referenced by exec_DELETEquery(), exec_SELECTquery(), exec_UPDATEquery(), and select_evalSingle().

t3lib_sqlengine::sql_affected_rows (   )

Returns affected rows (of UPDATE and DELETE queries) Returns: integer Last amount of affected rows. Reimplemented in tx_dbal_handler_rawmysql. Definition at line 455 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::sql_error (   )

Returns most recent error Returns: string Error message, if any Reimplemented in tx_dbal_handler_rawmysql. Definition at line 437 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::sql_insert_id (   )

Returns most recently create unique ID (of INSERT queries) Returns: integer Last unique id created. Reimplemented in tx_dbal_handler_rawmysql. Definition at line 446 of file class.t3lib_sqlengine.php.

t3lib_sqlengine::sql_query (  $  query  )

Performs an SQL query on the "database" Parameters: string  Query to execute Returns: object Result object or false if error Reimplemented in tx_dbal_handler_rawmysql. Definition at line 426 of file class.t3lib_sqlengine.php. References t3lib_div::makeInstance(). Referenced by admin_query().

---

The documentation for this class was generated from the following file:

• typo3_src-4.0/t3lib/class.t3lib_sqlengine.php

---