‪TYPO3CMS  10.4
TYPO3\CMS\Core\Database\QueryGenerator Class Reference

Public Member Functions

string makeFieldList ()
 
 init ($name, $table, $fieldList='', array $settings=[])
 
 setAndCleanUpExternalLists ($name, $list, $force='')
 
 procesData ($qC='')
 
array cleanUpQueryConfig ($queryConfig)
 
array getFormElements ($subLevel=0, $queryConfig='', $parent='')
 
string makeOptionList ($fieldName, $conf, $table)
 
string printCodeArray ($codeArr, $recursionLevel=0)
 
string mkOperatorSelect ($name, $op, $draw, $submit)
 
string mkTypeSelect ($name, $fieldName, $prepend='FIELD_')
 
string verifyType ($fieldName)
 
int verifyComparison ($comparison, $neg)
 
string mkFieldToInputSelect ($name, $fieldName)
 
string mkTableSelect ($name, $cur)
 
string mkCompSelect ($name, $comparison, $neg)
 
array getSubscript ($arr)
 
 initUserDef ()
 
string userDef ($fieldPrefix, $conf, $fieldName, $fieldType)
 
array userDefCleanUp ($queryConfig)
 
string getQuery ($queryConfig, $pad='')
 
string getQuerySingle ($conf, $first)
 
string cleanInputVal ($conf, $suffix='')
 
 getUserDefQuery ($qcArr, $first)
 
string updateIcon ()
 
string getLabelCol ()
 
string makeSelectorTable ($modSettings, $enableList='table, fields, query, group, order, limit')
 
string getTreeList ($id, $depth, $begin=0, $permClause='')
 
string getSelectQuery ($qString='')
 
 setFormName ($formName)
 

Public Attributes

array $lang
 
array $compSQL
 
array $comp_offsets
 
string $noWrap = ' nowrap'
 
string $name
 
string $table
 
array $tableArray
 
string $fieldList
 
array $fields = array( )
 
array $extFieldLists = array( )
 
array $queryConfig = array( )
 
bool $enablePrefix = false
 
bool $enableQueryParts = false
 

Protected Member Functions

string makeComparisonSelector ($subscript, $fieldName, $conf)
 
array convertIso8601DatetimeStringToUnixTimestamp (array $conf)
 
bool isDateOfIso8601Format ($date)
 
string getDateTimePickerField ($name, $timestamp, $type)
 
BackendUserAuthentication getBackendUserAuthentication ()
 
LanguageService getLanguageService ()
 

Protected Attributes

string $formName = ''
 
int $limitBegin
 
int $limitLength
 
string $fieldName
 
array $settings = array( )
 

Detailed Description

Class for generating front end for building queries

Definition at line 31 of file QueryGenerator.php.

Member Function Documentation

◆ cleanInputVal()

string TYPO3\CMS\Core\Database\QueryGenerator::cleanInputVal (   $conf,
  $suffix = '' 
)

◆ cleanUpQueryConfig()

◆ convertIso8601DatetimeStringToUnixTimestamp()

array TYPO3\CMS\Core\Database\QueryGenerator::convertIso8601DatetimeStringToUnixTimestamp ( array  $conf)
protected

Convert ISO-8601 timestamp (string) into unix timestamp (int)

Parameters
array$conf
Returns
‪array

Definition at line 1260 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\isDateOfIso8601Format().

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getQuery().

◆ getBackendUserAuthentication()

◆ getDateTimePickerField()

string TYPO3\CMS\Core\Database\QueryGenerator::getDateTimePickerField (   $name,
  $timestamp,
  $type 
)
protected
Parameters
string$name‪the field name
string$timestamp‪ISO-8601 timestamp
string$type‪[datetime, date, time, timesec, year]
Returns
‪string

Definition at line 1692 of file QueryGenerator.php.

References $GLOBALS, TYPO3\CMS\Core\Database\QueryGenerator\$name, and TYPO3\CMS\Core\Utility\StringUtility\getUniqueId().

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getFormElements().

◆ getFormElements()

◆ getLabelCol()

string TYPO3\CMS\Core\Database\QueryGenerator::getLabelCol ( )

Get label column

Returns
‪string

Definition at line 1399 of file QueryGenerator.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\QueryGenerator\$table.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\makeSelectorTable().

◆ getLanguageService()

LanguageService TYPO3\CMS\Core\Database\QueryGenerator::getLanguageService ( )
protected

◆ getQuery()

string TYPO3\CMS\Core\Database\QueryGenerator::getQuery (   $queryConfig,
  $pad = '' 
)

◆ getQuerySingle()

string TYPO3\CMS\Core\Database\QueryGenerator::getQuerySingle (   $conf,
  $first 
)

Get single query

Parameters
array$conf
bool$first
Returns
‪string

Definition at line 1295 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\cleanInputVal().

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getFormElements(), and TYPO3\CMS\Core\Database\QueryGenerator\getQuery().

◆ getSelectQuery()

◆ getSubscript()

array TYPO3\CMS\Core\Database\QueryGenerator::getSubscript (   $arr)

Get subscript

Parameters
array$arr
Returns
‪array

Definition at line 1172 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\procesData().

◆ getTreeList()

string TYPO3\CMS\Core\Database\QueryGenerator::getTreeList (   $id,
  $depth,
  $begin = 0,
  $permClause = '' 
)

Recursively fetch all descendants of a given page

Parameters
int$id‪uid of the page
int$depth
int$begin
string$permClause
Returns
‪string comma separated list of descendant pages

Definition at line 1557 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getSelectQuery(), and TYPO3\CMS\Core\Database\QueryGenerator\makeOptionList().

◆ getUserDefQuery()

TYPO3\CMS\Core\Database\QueryGenerator::getUserDefQuery (   $qcArr,
  $first 
)

Get user definition query

Parameters
array$qcArr
bool$first

Definition at line 1380 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getQuery().

◆ init()

TYPO3\CMS\Core\Database\QueryGenerator::init (   $name,
  $table,
  $fieldList = '',
array  $settings = [] 
)

◆ initUserDef()

TYPO3\CMS\Core\Database\QueryGenerator::initUserDef ( )

Init user definition

Definition at line 1191 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\init().

◆ isDateOfIso8601Format()

bool TYPO3\CMS\Core\Database\QueryGenerator::isDateOfIso8601Format (   $date)
protected

Checks if the given value is of the ISO 8601 format.

Parameters
mixed$date
Returns
‪bool

Definition at line 1278 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\convertIso8601DatetimeStringToUnixTimestamp().

◆ makeComparisonSelector()

string TYPO3\CMS\Core\Database\QueryGenerator::makeComparisonSelector (   $subscript,
  $fieldName,
  $conf 
)
protected

◆ makeFieldList()

string TYPO3\CMS\Core\Database\QueryGenerator::makeFieldList ( )

Make a list of fields for current table

Returns
‪string Separated list of fields

Definition at line 239 of file QueryGenerator.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\QueryGenerator\$table.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\init().

◆ makeOptionList()

◆ makeSelectorTable()

◆ mkCompSelect()

string TYPO3\CMS\Core\Database\QueryGenerator::mkCompSelect (   $name,
  $comparison,
  $neg 
)

Make comparison select

Parameters
string$name
string$comparison
int$neg
Returns
‪string

Definition at line 1152 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\$name.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\makeComparisonSelector().

◆ mkFieldToInputSelect()

string TYPO3\CMS\Core\Database\QueryGenerator::mkFieldToInputSelect (   $name,
  $fieldName 
)

◆ mkOperatorSelect()

string TYPO3\CMS\Core\Database\QueryGenerator::mkOperatorSelect (   $name,
  $op,
  $draw,
  $submit 
)

Make operator select

Parameters
string$name
string$op
bool$draw
bool$submit
Returns
‪string

Definition at line 1014 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\$name.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getFormElements().

◆ mkTableSelect()

string TYPO3\CMS\Core\Database\QueryGenerator::mkTableSelect (   $name,
  $cur 
)

◆ mkTypeSelect()

string TYPO3\CMS\Core\Database\QueryGenerator::mkTypeSelect (   $name,
  $fieldName,
  $prepend = 'FIELD_' 
)

◆ printCodeArray()

string TYPO3\CMS\Core\Database\QueryGenerator::printCodeArray (   $codeArr,
  $recursionLevel = 0 
)

Print code array

Parameters
array$codeArr
int$recursionLevel
Returns
‪string

Definition at line 981 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\makeSelectorTable().

◆ procesData()

TYPO3\CMS\Core\Database\QueryGenerator::procesData (   $qC = '')

◆ setAndCleanUpExternalLists()

TYPO3\CMS\Core\Database\QueryGenerator::setAndCleanUpExternalLists (   $name,
  $list,
  $force = '' 
)

◆ setFormName()

TYPO3\CMS\Core\Database\QueryGenerator::setFormName (   $formName)

Sets the current name of the input form.

Parameters
string$formName‪The name of the form.

Definition at line 1714 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\$formName.

◆ updateIcon()

string TYPO3\CMS\Core\Database\QueryGenerator::updateIcon ( )

◆ userDef()

string TYPO3\CMS\Core\Database\QueryGenerator::userDef (   $fieldPrefix,
  $conf,
  $fieldName,
  $fieldType 
)

User definition

Parameters
string$fieldPrefix
array$conf
string$fieldName
string$fieldType
Returns
‪string

Definition at line 1205 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\getFormElements().

◆ userDefCleanUp()

array TYPO3\CMS\Core\Database\QueryGenerator::userDefCleanUp (   $queryConfig)

User definition clean up

Parameters
array$queryConfig
Returns
‪array

Definition at line 1216 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\$queryConfig.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\cleanUpQueryConfig().

◆ verifyComparison()

int TYPO3\CMS\Core\Database\QueryGenerator::verifyComparison (   $comparison,
  $neg 
)

Verify comparison

Parameters
string$comparison
int$neg
Returns
‪int

Definition at line 1080 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\cleanUpQueryConfig().

◆ verifyType()

string TYPO3\CMS\Core\Database\QueryGenerator::verifyType (   $fieldName)

Verify type

Parameters
string$fieldName
Returns
‪string

Definition at line 1059 of file QueryGenerator.php.

References TYPO3\CMS\Core\Database\QueryGenerator\$fieldName.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\cleanUpQueryConfig().

Member Data Documentation

◆ $comp_offsets

array TYPO3\CMS\Core\Database\QueryGenerator::$comp_offsets
Initial value:
= array(
'text' => 0,
'number' => 1,
'multiple' => 2,
'relation' => 2,
'date' => 3,
'time' => 3,
'boolean' => 4,
'binary' => 5
)

Definition at line 153 of file QueryGenerator.php.

◆ $compSQL

array TYPO3\CMS\Core\Database\QueryGenerator::$compSQL

Definition at line 96 of file QueryGenerator.php.

◆ $enablePrefix

bool TYPO3\CMS\Core\Database\QueryGenerator::$enablePrefix = false

Definition at line 208 of file QueryGenerator.php.

◆ $enableQueryParts

bool TYPO3\CMS\Core\Database\QueryGenerator::$enableQueryParts = false

Definition at line 212 of file QueryGenerator.php.

◆ $extFieldLists

array TYPO3\CMS\Core\Database\QueryGenerator::$extFieldLists = array( )

Definition at line 198 of file QueryGenerator.php.

◆ $fieldList

string TYPO3\CMS\Core\Database\QueryGenerator::$fieldList

◆ $fieldName

◆ $fields

array TYPO3\CMS\Core\Database\QueryGenerator::$fields = array( )

Array of the fields possible

Definition at line 194 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\setAndCleanUpExternalLists().

◆ $formName

string TYPO3\CMS\Core\Database\QueryGenerator::$formName = ''
protected

◆ $lang

array TYPO3\CMS\Core\Database\QueryGenerator::$lang

Definition at line 35 of file QueryGenerator.php.

◆ $limitBegin

int TYPO3\CMS\Core\Database\QueryGenerator::$limitBegin
protected

Definition at line 220 of file QueryGenerator.php.

◆ $limitLength

int TYPO3\CMS\Core\Database\QueryGenerator::$limitLength
protected

◆ $name

◆ $noWrap

string TYPO3\CMS\Core\Database\QueryGenerator::$noWrap = ' nowrap'

Definition at line 166 of file QueryGenerator.php.

◆ $queryConfig

◆ $settings

array TYPO3\CMS\Core\Database\QueryGenerator::$settings = array( )
protected

Settings, usually from the controller, previously known as MOD_SETTINGS

Definition at line 232 of file QueryGenerator.php.

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\init().

◆ $table

◆ $tableArray

array TYPO3\CMS\Core\Database\QueryGenerator::$tableArray

Definition at line 182 of file QueryGenerator.php.