t3lib_sqlengine Class Reference

Inherits t3lib_sqlparser.

List of all members.

Public Member Functions
	init ($config, &$pObj)
	Dummy function for initializing SQL handler.
	resetStatusVars ()
	Reset SQL engine status variables (insert id, affected rows, error status).
	processAccordingToConfig (&$value, $fInfo)
	Processing of update/insert values based on field type.
	exec_INSERTquery ($table, $fields_values)
	Execute an INSERT query.
	exec_UPDATEquery ($table, $where, $fields_values)
	Execute UPDATE query on table.
	exec_DELETEquery ($table, $where)
	Execute DELETE query.
	exec_SELECTquery ($select_fields, $from_table, $where_clause, $groupBy, $orderBy, $limit)
	Execute SELECT query.
	sql_query ($query)
	Performs an SQL query on the "database".
	sql_error ()
	Returns most recent error.
	sql_insert_id ()
	Returns most recently create unique ID (of INSERT queries).
	sql_affected_rows ()
	Returns affected rows (of UPDATE and DELETE queries).
	quoteStr ($str)
	Quoting strings for insertion in SQL queries.
	admin_get_tables ()
	(DUMMY) Returns the list of tables from the database
	admin_get_fields ($tableName)
	(DUMMY) Returns information about each field in the $table
	admin_get_keys ($tableName)
	(DUMMY) Returns information about each index key in the $table
	admin_query ($query)
	(DUMMY) mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!
	readDataSource ($table)
	Dummy function for setting table data.
	saveDataSource ($table)
	Dummy function for setting table data.
	selectFromData ($table, $where)
	[Describe function...]
	select_evalSingle ($table, $config, &$itemKeys)
	[Describe function...]
	getResultSet ($keys, $table, $fieldList)
	[Describe function...]
	debug_printResultSet ($array)
	Returns the result set (in array) as HTML table.
Public Attributes
	$data = array()
	$errorStatus = ''
	$lastInsertedId = 0
	$lastAffectedRows = 0

---

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 Definition at line 495 of file class.t3lib_sqlengine.php. Referenced by exec_INSERTquery(), and exec_UPDATEquery(). { $output = array(); return $output; }

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 Definition at line 506 of file class.t3lib_sqlengine.php. { $output = array(); return $output; }

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) Definition at line 484 of file class.t3lib_sqlengine.php. { $whichTables = array(); return $whichTables; }

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 Definition at line 517 of file class.t3lib_sqlengine.php. References sql_query(). { return $this->sql_query($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 785 of file class.t3lib_sqlengine.php. References $tRows, and table(). { if (count($array)) { $tRows=array(); $fields = array_keys(current($array)); $tCell[]=' <td>IDX</td>'; foreach($fields as $fieldName) { $tCell[]=' <td>'.htmlspecialchars($fieldName).'</td>'; } $tRows[]='<tr>'.implode('',$tCell).'</tr>'; foreach($array as $index => $rec) { $tCell=array(); $tCell[]=' <td>'.htmlspecialchars($index).'</td>'; foreach($fields as $fieldName) { $tCell[]=' <td>'.htmlspecialchars($rec[$fieldName]).'</td>'; } $tRows[]='<tr>'.implode('',$tCell).'</tr>'; } return '<table border="1">'.implode('',$tRows).'</table>'; } else 'Empty resultset'; }

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) Definition at line 326 of file class.t3lib_sqlengine.php. References t3lib_sqlparser::parseWhereClause(), readDataSource(), resetStatusVars(), saveDataSource(), selectFromData(), and table(). { // Initialize: $this->resetStatusVars(); // Reading Data Source if not done already. $this->readDataSource($table); // If anything is there: if (is_array($this->data[$table])) { // Parse WHERE clause: $where = $this->parseWhereClause($where); if (is_array($where)) { // Do query, returns array with keys to the data array of the result: $itemKeys = $this->selectFromData($table,$where); // Set "last affected rows": $this->lastAffectedRows = count($itemKeys); // Remove rows: if ($this->lastAffectedRows) { // Traverse result set: foreach($itemKeys as $dataArrayKey) { unset($this->data[$table][$dataArrayKey]); } // Saving data source $this->saveDataSource($table); } return TRUE; } else $this->errorStatus = 'WHERE clause contained errors: '.$where; } else $this->errorStatus = 'No data loaded.'; return FALSE; }

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) Definition at line 200 of file class.t3lib_sqlengine.php. References admin_get_fields(), processAccordingToConfig(), readDataSource(), resetStatusVars(), saveDataSource(), and table(). { // Initialize $this->resetStatusVars(); // Reading Data Source if not done already. $this->readDataSource($table); // If data source is set: if (is_array($this->data[$table])) { $fieldInformation = $this->admin_get_fields($table); // Should cache this...! // Looking for unique keys: $saveArray = array(); foreach($fieldInformation as $fInfo) { // Field name: $fN = $fInfo['Field']; // Set value: $saveArray[$fN] = isset($fields_values[$fN]) ? $fields_values[$fN] : $options['Default']; // Process value: $this->processAccordingToConfig($saveArray[$fN], $fInfo); // If an auto increment field is found, find the largest current uid: if ($fInfo['Extra'] == 'auto_increment') { // Get all UIDs: $uidArray = array(); foreach($this->data[$table] as $r) { $uidArray[] = $r[$fN]; } // If current value is blank or already in array, we create a new: if (!$saveArray[$fN] || in_array(intval($saveArray[$fN]), $uidArray)) { if (count($uidArray)) { $saveArray[$fN] = max($uidArray)+1; } else $saveArray[$fN] = 1; } // Update "last inserted id": $this->lastInsertedId = $saveArray[$fN]; } } #debug(array($fields_values,$saveArray)); // Insert row in table: $this->data[$table][] = $saveArray; // Save data source $this->saveDataSource($table); return TRUE; } else $this->errorStatus = 'No data loaded.'; return FALSE; }

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->quoteStr() 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 Definition at line 377 of file class.t3lib_sqlengine.php. References getResultSet(), t3lib_sqlparser::parseFromTables(), t3lib_sqlparser::parseWhereClause(), readDataSource(), resetStatusVars(), selectFromData(), and table(). { // Initialize: $this->resetStatusVars(); // Create result object $sqlObj = t3lib_div::makeInstance('t3lib_sqlengine_resultobj'); $sqlObj->result = array(); // Empty result as a beginning // Get table list: $tableArray = $this->parseFromTables($from_table); $table = $tableArray[0]['table']; // Reading Data Source if not done already. $this->readDataSource($table); // If anything is there: if (is_array($this->data[$table])) { // Parse WHERE clause: $where = $this->parseWhereClause($where_clause); if (is_array($where)) { // Do query, returns array with keys to the data array of the result: $itemKeys = $this->selectFromData($table,$where); // Finally, read the result rows into this variable: $sqlObj->result = $this->getResultSet($itemKeys,$table,'*'); // Reset and return result: reset($sqlObj->result); return $sqlObj; } else $this->errorStatus = 'WHERE clause contained errors: '.$where; } else $this->errorStatus = 'No data loaded: '.$this->errorStatus; return FALSE; }

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) Definition at line 267 of file class.t3lib_sqlengine.php. References admin_get_fields(), t3lib_sqlparser::parseWhereClause(), processAccordingToConfig(), readDataSource(), resetStatusVars(), saveDataSource(), selectFromData(), and table(). { // Initialize: $this->resetStatusVars(); // Reading Data Source if not done already. $this->readDataSource($table); // If anything is there: if (is_array($this->data[$table])) { // Parse WHERE clause: $where = $this->parseWhereClause($where); if (is_array($where)) { // Field information $fieldInformation = $this->admin_get_fields($table); // Should cache this...! // Traverse fields to update: foreach($fields_values as $fName => $fValue) { $this->processAccordingToConfig($fields_values[$fName],$fieldInformation[$fName]); } #debug($fields_values); // Do query, returns array with keys to the data array of the result: $itemKeys = $this->selectFromData($table,$where); // Set "last affected rows": $this->lastAffectedRows = count($itemKeys); // Update rows: if ($this->lastAffectedRows) { // Traverse result set here: foreach($itemKeys as $dataArrayKey) { // Traverse fields to update: foreach($fields_values as $fName => $fValue) { $this->data[$table][$dataArrayKey][$fName] = $fValue; } } // Save data source $this->saveDataSource($table); } return TRUE; } else $this->errorStatus = 'WHERE clause contained errors: '.$where; } else $this->errorStatus = 'No data loaded.'; return FALSE; }

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

[Describe function...] Parameters: [type]  $keys: ... [type]  $table: ... [type]  $fields: ... Returns: [type] ... Definition at line 740 of file class.t3lib_sqlengine.php. Referenced by exec_SELECTquery(). { $fields = t3lib_div::trimExplode(',',$fieldList); $output = array(); foreach($keys as $kValue) { if ($fieldList=='*') { $output[$kValue] = $this->data[$table][$kValue]; } else { foreach($fields as $fieldName) { $output[$kValue][$fieldName] = $this->data[$table][$kValue][$fieldName]; } } } return $output; }

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 Definition at line 124 of file class.t3lib_sqlengine.php. { }

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

Processing of update/insert values based on field type. Parameters: [type]  $$value: ... [type]  $fInfo: ... Returns: [type] ... Definition at line 145 of file class.t3lib_sqlengine.php. References t3lib_sqlparser::parseFieldDef(). Referenced by exec_INSERTquery(), and exec_UPDATEquery(). { $options = $this->parseFieldDef($fInfo['Type']); switch(strtolower($options['fieldType'])) { case 'int': case 'smallint': case 'tinyint': case 'mediumint': $value = intval($value); if ($options['featureIndex']['UNSIGNED']) { $value = t3lib_div::intInRange($value,0); } break; case 'double': $value = (double)$value; break; case 'varchar': case 'char': $value = substr($value,0,trim($options['value'])); break; case 'text': case 'blob': $value = substr($value,0,65536); break; case 'tinytext': case 'tinyblob': $value = substr($value,0,256); break; case 'mediumtext': case 'mediumblob': // ?? break; } }

t3lib_sqlengine::quoteStr (  $  str  )

Quoting strings for insertion in SQL queries. Parameters: string  String Returns: string String, with quotes escaped Definition at line 459 of file class.t3lib_sqlengine.php. { return addslashes($str); }

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? Definition at line 542 of file class.t3lib_sqlengine.php. Referenced by exec_DELETEquery(), exec_INSERTquery(), exec_SELECTquery(), and exec_UPDATEquery(). { $this->data[$table] = array(); }

t3lib_sqlengine::resetStatusVars (   )

Reset SQL engine status variables (insert id, affected rows, error status). Returns: void Definition at line 132 of file class.t3lib_sqlengine.php. Referenced by exec_DELETEquery(), exec_INSERTquery(), exec_SELECTquery(), and exec_UPDATEquery(). { $this->errorStatus = ''; $this->lastInsertedId = 0; $this->lastAffectedRows = 0; }

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? Definition at line 554 of file class.t3lib_sqlengine.php. References debug(), and table(). Referenced by exec_DELETEquery(), exec_INSERTquery(), and exec_UPDATEquery(). { debug($this->data[$table]); }

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

[Describe function...] Parameters: [type]  $table: ... [type]  $config: ... [type]  $itemKeys: ... Returns: [type] ... Definition at line 619 of file class.t3lib_sqlengine.php. References selectFromData(), and table(). Referenced by selectFromData(). { $neg = ereg('^AND[[:space:]]+NOT$',trim($config['operator'])); if (is_array($config['sub'])) { $subSelKeys = $this->selectFromData($table,$config['sub']); if ($neg) { foreach($itemKeys as $kk => $vv) { if (in_array($vv,$subSelKeys)) { unset($itemKeys[$kk]); } } } else { $itemKeys = array_intersect($itemKeys, $subSelKeys); } } else { $comp = strtoupper(ereg_replace('[[:space:]]','',$config['comparator'])); $mod = strtoupper($config['modifier']); switch($comp) { case 'NOTLIKE': case 'LIKE': $like_value = strtolower($config['value'][0]); if (substr($like_value,0,1)=='%') { $wildCard_begin = TRUE; $like_value = substr($like_value,1); } if (substr($like_value,-1)=='%') { $wildCard_end = TRUE; $like_value = substr($like_value,0,-1); } break; case 'NOTIN': case 'IN': $in_valueArray = array(); foreach($config['value'] as $vParts) { $in_valueArray[] = (string)$vParts[0]; } break; } foreach($itemKeys as $kk => $v) { $field_value = $this->data[$table][$v][$config['field']]; // Calculate it: if ($config['calc']=='&') { $field_value&=intval($config['calc_value']); } // Compare it: switch($comp) { case '<=': $bool = $field_value <= $config['value'][0]; break; case '>=': $bool = $field_value >= $config['value'][0]; break; case '<': $bool = $field_value < $config['value'][0]; break; case '>': $bool = $field_value > $config['value'][0]; break; case '=': $bool = !strcmp($field_value,$config['value'][0]); break; case '!=': $bool = strcmp($field_value,$config['value'][0]); break; case 'NOTIN': case 'IN': $bool = in_array((string)$field_value, $in_valueArray); if ($comp=='NOTIN') $bool = !$bool; break; case 'NOTLIKE': case 'LIKE': if (!strlen($like_value)) { $bool = TRUE; } elseif ($wildCard_begin && !$wildCard_end) { $bool = !strcmp(substr(strtolower($field_value),-strlen($like_value)),$like_value); } elseif (!$wildCard_begin && $wildCard_end) { $bool = !strcmp(substr(strtolower($field_value),0,strlen($like_value)),$like_value); } elseif ($wildCard_begin && $wildCard_end) { $bool = strstr($field_value,$like_value); } else { $bool = !strcmp(strtolower($field_value),$like_value); } if ($comp=='NOTLIKE') $bool = !$bool; break; default: $bool = $field_value ? TRUE : FALSE; break; } // General negation: if ($neg) $bool = !$bool; // Modify? switch($mod) { case 'NOT': case '!': $bool = !$bool; break; } // Action: if (!$bool) { unset($itemKeys[$kk]); } } # echo $this->debug_printResultSet($this->getResultSet($itemKeys,$table,'uid,tstamp')); } }

t3lib_sqlengine::selectFromData (  $  table, $  where )

[Describe function...] Parameters: [type]  $table: ... [type]  $where: ... Returns: [type] ... Definition at line 583 of file class.t3lib_sqlengine.php. References select_evalSingle(), and table(). Referenced by exec_DELETEquery(), exec_SELECTquery(), exec_UPDATEquery(), and select_evalSingle(). { $output = array(); if (is_array($this->data[$table])) { // All keys: $OR_index = 0; foreach($where as $config) { if (strtoupper($config['operator'])=='OR') { $OR_index++; } if (!isset($itemKeys[$OR_index])) $itemKeys[$OR_index] = array_keys($this->data[$table]); $this->select_evalSingle($table,$config,$itemKeys[$OR_index]); } foreach($itemKeys as $uidKeys) { $output = array_merge($output, $uidKeys); } $output = array_unique($output); } return $output; }

t3lib_sqlengine::sql_affected_rows (   )

Returns affected rows (of UPDATE and DELETE queries). Returns: integer Last amount of affected rows. Definition at line 449 of file class.t3lib_sqlengine.php. { return $this->lastAffectedRows; }

t3lib_sqlengine::sql_error (   )

Returns most recent error. Returns: string Error message, if any Definition at line 431 of file class.t3lib_sqlengine.php. { return $this->errorStatus; }

t3lib_sqlengine::sql_insert_id (   )

Returns most recently create unique ID (of INSERT queries). Returns: integer Last unique id created. Definition at line 440 of file class.t3lib_sqlengine.php. { return $this->lastInsertedId; }

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 Definition at line 420 of file class.t3lib_sqlengine.php. Referenced by admin_query(). { $res = t3lib_div::makeInstance('t3lib_sqlengine_resultobj'); $res->result = array(); return $res; }

---

Member Data Documentation

t3lib_sqlengine::$data = array()

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

t3lib_sqlengine::$errorStatus = ''

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

t3lib_sqlengine::$lastAffectedRows = 0

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

t3lib_sqlengine::$lastInsertedId = 0

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

---

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

• t3lib/class.t3lib_sqlengine.php

---