QuerySearchController

class \TYPO3\CMS\Lowlevel\Controller\QuerySearchController

"Database > Advanced query" module.

Attributes

#[AsController]

Table of Contents

Properties

$comp_offsets  : array
$componentFactory  : ComponentFactory
$compSQL  : array
$enablePrefix  : bool
$enableQueryParts  : bool
$extFieldLists  : array
$fieldList  : string
$fieldName  : string
$fields  : array
$flashMessageRendererResolver  : FlashMessageRendererResolver
$formName  : string
$iconFactory  : IconFactory
$lang  : array
$MOD_MENU  : array
The module menu items array.
$MOD_SETTINGS  : array
Current settings for the keys of the MOD_MENU array.
$moduleName  : string
$moduleTemplateFactory  : ModuleTemplateFactory
$name  : string
$noDownloadB  : int
$pageDoktypeRegistry  : PageDoktypeRegistry
$queryConfig  : array
$responseFactory  : ResponseFactoryInterface
$showFieldAndTableNames  : bool
If the current user is an admin and $GLOBALS['TYPO3_CONF_VARS']['BE']['debug'] is set to true, the names of fields and tables are displayed.
$storeList  : string
$table  : string
$tableArray  : array
$tcaSchemaFactory  : TcaSchemaFactory
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
handleRequest()  : ResponseInterface
addToStoreQueryConfigs()  : array
cleanInputVal()  : mixed
cleanStoreQueryConfigs()  : array
cleanUpQueryConfig()  : array
convertIso8601DatetimeStringToUnixTimestamp()  : array
csvValues()  : string
evaluateRelationDisplayWithLabels()  : string
Helper method to evaluate a specific field configuration and decide which label to return.
getBackendUserAuthentication()  : BackendUserAuthentication
getDateTimePickerField()  : string
getDropdownMenu()  : string
Returns a selector box to switch the view.
getFormElements()  : array
getFuncCheck()  : string
Checkbox function menu.
getLabelCol()  : string
getLanguageService()  : LanguageService
getProcessedValueExtra()  : string
getQuery()  : string
getQueryResultCode()  : array
getQuerySingle()  : string
getSelectQuery()  : string
getSubscript()  : array
getTreeList()  : string
Recursively fetch all descendants of a given page
init()  : void
initStoreArray()  : array
isDateOfIso8601Format()  : bool
Checks if the given value is of the ISO 8601 format.
loadStoreQueryConfigs()  : array
makeComparisonSelector()  : string
makeFieldList()  : string
makeOptionList()  : string
makeSelectorTable()  : string
makeStoreControl()  : string
makeValueList()  : string
menuConfig()  : void
Configure menu
mkCompSelect()  : string
mkFieldToInputSelect()  : string
mkOperatorSelect()  : string
mkTableSelect()  : string
mkTypeSelect()  : string
printCodeArray()  : string
procesData()  : void
procesStoreControl()  : string
queryMaker()  : string
resultRowDisplay()  : string
resultRowTitles()  : string
setAndCleanUpExternalLists()  : void
updateIcon()  : string
verifyComparison()  : int
verifyType()  : string

Properties

$comp_offsets

protected array $comp_offsets = ['text' => 0, 'number' => 1, 'multiple' => 2, 'relation' => …
Show the full value['text' => 0, 'number' => 1, 'multiple' => 2, 'relation' => 2, 'date' => 3, 'time' => 3, 'boolean' => 4, 'binary' => 5]

$compSQL

protected array $compSQL = [ // Type = text offset = 0 '0' => '#FIELD# LIKE \'%…
Show the full value[ // Type = text offset = 0 '0' => '#FIELD# LIKE \'%#VALUE#%\'', '1' => '#FIELD# NOT LIKE \'%#VALUE#%\'', '2' => '#FIELD# LIKE \'#VALUE#%\'', '3' => '#FIELD# NOT LIKE \'#VALUE#%\'', '4' => '#FIELD# LIKE \'%#VALUE#\'', '5' => '#FIELD# NOT LIKE \'%#VALUE#\'', '6' => '#FIELD# = \'#VALUE#\'', '7' => '#FIELD# != \'#VALUE#\'', // Type = number, offset = 32 '32' => '#FIELD# = \'#VALUE#\'', '33' => '#FIELD# != \'#VALUE#\'', '34' => '#FIELD# > #VALUE#', '35' => '#FIELD# < #VALUE#', '36' => '#FIELD# >= #VALUE# AND #FIELD# <= #VALUE1#', '37' => 'NOT (#FIELD# >= #VALUE# AND #FIELD# <= #VALUE1#)', '38' => '#FIELD# IN (#VALUE#)', '39' => '#FIELD# NOT IN (#VALUE#)', '40' => '(#FIELD# & #VALUE#)=#VALUE#', '41' => '(#FIELD# & #VALUE#)!=#VALUE#', '42' => '(#FIELD# | #VALUE#)=#VALUE#', '43' => '(#FIELD# | #VALUE#)!=#VALUE#', // Type = multiple, relation, offset = 64 '64' => '#FIELD# = \'#VALUE#\'', '65' => '#FIELD# != \'#VALUE#\'', '66' => '#FIELD# LIKE \'%#VALUE#%\' AND #FIELD# LIKE \'%#VALUE1#%\'', '67' => '(#FIELD# NOT LIKE \'%#VALUE#%\' OR #FIELD# NOT LIKE \'%#VALUE1#%\')', '68' => '#FIELD# IN (#VALUE#)', '69' => '#FIELD# NOT IN (#VALUE#)', '70' => '(#FIELD# & #VALUE#)=#VALUE#', '71' => '(#FIELD# & #VALUE#)!=#VALUE#', '72' => '(#FIELD# | #VALUE#)=#VALUE#', '73' => '(#FIELD# | #VALUE#)!=#VALUE#', // Type = date, offset = 32 '96' => '#FIELD# = \'#VALUE#\'', '97' => '#FIELD# != \'#VALUE#\'', '98' => '#FIELD# > #VALUE#', '99' => '#FIELD# < #VALUE#', '100' => '#FIELD# >= #VALUE# AND #FIELD# <= #VALUE1#', '101' => 'NOT (#FIELD# >= #VALUE# AND #FIELD# <= #VALUE1#)', '102' => '(#FIELD# & #VALUE#)=#VALUE#', '103' => '(#FIELD# & #VALUE#)!=#VALUE#', '104' => '(#FIELD# | #VALUE#)=#VALUE#', '105' => '(#FIELD# | #VALUE#)!=#VALUE#', // Type = boolean, offset = 128 '128' => '#FIELD# = \'1\'', '129' => '#FIELD# != \'1\'', // Type = binary = 160 '160' => '#FIELD# = \'#VALUE#\'', '161' => '#FIELD# != \'#VALUE#\'', '162' => '(#FIELD# & #VALUE#)=#VALUE#', '163' => '(#FIELD# & #VALUE#)=0', ]

$enablePrefix

protected bool $enablePrefix = false

$enableQueryParts

protected bool $enableQueryParts = false

$extFieldLists

protected array $extFieldLists = []

$fieldName

protected string $fieldName = ''

$lang

protected array $lang = ['OR' => 'or', 'AND' => 'and', 'comparison' => [ // Type…
Show the full value['OR' => 'or', 'AND' => 'and', 'comparison' => [ // Type = text offset = 0 '0_' => 'contains', '1_' => 'does not contain', '2_' => 'starts with', '3_' => 'does not start with', '4_' => 'ends with', '5_' => 'does not end with', '6_' => 'equals', '7_' => 'does not equal', // Type = number , offset = 32 '32_' => 'equals', '33_' => 'does not equal', '34_' => 'is greater than', '35_' => 'is less than', '36_' => 'is between', '37_' => 'is not between', '38_' => 'is in list', '39_' => 'is not in list', '40_' => 'binary AND equals', '41_' => 'binary AND does not equal', '42_' => 'binary OR equals', '43_' => 'binary OR does not equal', // Type = multiple, relation, offset = 64 '64_' => 'equals', '65_' => 'does not equal', '66_' => 'contains', '67_' => 'does not contain', '68_' => 'is in list', '69_' => 'is not in list', '70_' => 'binary AND equals', '71_' => 'binary AND does not equal', '72_' => 'binary OR equals', '73_' => 'binary OR does not equal', // Type = date,time offset = 96 '96_' => 'equals', '97_' => 'does not equal', '98_' => 'is greater than', '99_' => 'is less than', '100_' => 'is between', '101_' => 'is not between', '102_' => 'binary AND equals', '103_' => 'binary AND does not equal', '104_' => 'binary OR equals', '105_' => 'binary OR does not equal', // Type = boolean, offset = 128 '128_' => 'is True', '129_' => 'is False', // Type = binary , offset = 160 '160_' => 'equals', '161_' => 'does not equal', '162_' => 'contains', '163_' => 'does not contain', ]]

$MOD_MENU

The module menu items array.

protected array $MOD_MENU = []

$MOD_SETTINGS

Current settings for the keys of the MOD_MENU array.

protected array $MOD_SETTINGS = []

$moduleName

protected string $moduleName = 'system_database_query'

$noDownloadB

protected int $noDownloadB = 0

$queryConfig

protected array $queryConfig = []

$responseFactory read-only

protected ResponseFactoryInterface $responseFactory

$showFieldAndTableNames

If the current user is an admin and $GLOBALS['TYPO3_CONF_VARS']['BE']['debug'] is set to true, the names of fields and tables are displayed.

protected bool $showFieldAndTableNames = false

$storeList

protected string $storeList = 'search_query_smallparts,search_result_labels,labels_noprefi…
Show the full value'search_query_smallparts,search_result_labels,labels_noprefix,show_deleted,queryConfig,queryTable,queryFields,queryLimit,queryOrder,queryOrderDesc,queryOrder2,queryOrder2Desc,queryGroup,search_query_makeQuery'

$tableArray

protected array $tableArray = []

Methods

__construct()

public __construct(IconFactory $iconFactory, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory, TcaSchemaFactory $tcaSchemaFactory, FlashMessageRendererResolver $flashMessageRendererResolver, PageDoktypeRegistry $pageDoktypeRegistry, ComponentFactory $componentFactory, ResponseFactoryInterface $responseFactory) : mixed

Parameters

$iconFactory : IconFactory
$uriBuilder : UriBuilder
$moduleTemplateFactory : ModuleTemplateFactory
$tcaSchemaFactory : TcaSchemaFactory
$flashMessageRendererResolver : FlashMessageRendererResolver
$pageDoktypeRegistry : PageDoktypeRegistry
$componentFactory : ComponentFactory
$responseFactory : ResponseFactoryInterface

handleRequest()

public handleRequest(ServerRequestInterface $request) : ResponseInterface

Parameters

$request : ServerRequestInterface

Return values

ResponseInterface

addToStoreQueryConfigs()

protected addToStoreQueryConfigs(array $storeQueryConfigs, int $index) : array

Parameters

$storeQueryConfigs : array
$index : int

Return values

array

cleanInputVal()

protected cleanInputVal(array $conf[, string $suffix = '' ]) : mixed

Parameters

$conf : array
$suffix : string = ''

cleanStoreQueryConfigs()

protected cleanStoreQueryConfigs(array $storeQueryConfigs, array $storeArray) : array

Parameters

$storeQueryConfigs : array
$storeArray : array

Return values

array

cleanUpQueryConfig()

protected cleanUpQueryConfig(array $queryConfig) : array

Parameters

$queryConfig : array

Return values

array

convertIso8601DatetimeStringToUnixTimestamp()

protected convertIso8601DatetimeStringToUnixTimestamp(array $conf) : array

Parameters

$conf : array

Return values

array

csvValues()

protected csvValues(array $row[, string $table = '' ]) : string

Parameters

$row : array
$table : string = ''

Return values

string

evaluateRelationDisplayWithLabels()

Helper method to evaluate a specific field configuration and decide which label to return.

protected evaluateRelationDisplayWithLabels(bool $useSelectLabels, bool $useAltSelectLabels, LabelCapability $labelCapability, string|null $altLabelFieldName, array $val, array $labelFieldSelect, array $altLabelFieldSelect, string|null $labelFieldName) : string

This is used for both the dropdown when choosing a WHERE condition, but also for the record list itself, when inline relations are resolved in case the option "[search_result_labels]" is set.

Parameters

$useSelectLabels : bool
  • Whether foreign resolving of a primary TCA 'label' field is required
$useAltSelectLabels : bool
  • Whether foreign resolving of the FIRST TCA 'label_alt' relation field is required
$labelCapability : LabelCapability
  • Schema capability information, used here for the table's label/label_alt evaluation
$altLabelFieldName : string|null
  • The name of the matched first TCA 'label_alt' relation field
$val : array
  • The DB SQL result row array
$labelFieldSelect : array
  • An array holding the possible select values of a 'label' relation
$altLabelFieldSelect : array
  • An array holding the possible select values of a 'label_alt' relation
$labelFieldName : string|null
  • The name of the primary TCA column used for the label

Tags

todo

Please refactor me.

Return values

string

getDateTimePickerField()

protected getDateTimePickerField(string $name, string $timestamp, string $type) : string

Parameters

$name : string
$timestamp : string
$type : string

Return values

string

getDropdownMenu()

Returns a selector box to switch the view.

protected getDropdownMenu(string $elementName, string|int $currentValue, mixed $menuItems, ServerRequestInterface $request) : string

Parameters

$elementName : string

The form elements name, probably something like "SET[...]

$currentValue : string|int

The value to be selected currently.

$menuItems : mixed

An array with the menu items for the selector box

$request : ServerRequestInterface

Return values

string —

HTML code for selector box

getFormElements()

protected getFormElements([int $subLevel = 0 ][, string|array|null $queryConfig = null ][, string $parent = '' ]) : array

Parameters

$subLevel : int = 0
$queryConfig : string|array|null = null
$parent : string = ''

Return values

array

getFuncCheck()

Checkbox function menu.

protected getFuncCheck(string $elementName, string|bool|int $currentValue, ServerRequestInterface $request[, string $tagParams = '' ]) : string

Parameters

$elementName : string

The form elements name, probably something like "SET[...]

$currentValue : string|bool|int

The value to be selected currently.

$request : ServerRequestInterface
$tagParams : string = ''

Additional attributes for the checkbox input tag

Return values

string —

HTML code for checkbox

getLabelCol()

protected getLabelCol() : string

Return values

string

getProcessedValueExtra()

protected getProcessedValueExtra(string $table, string $fieldName, string $fieldValue, string $splitString) : string

Parameters

$table : string
$fieldName : string
$fieldValue : string
$splitString : string

Return values

string

getQuery()

protected getQuery(array $queryConfig[, string $pad = '' ]) : string

Parameters

$queryConfig : array
$pad : string = ''

Return values

string

getQueryResultCode()

protected getQueryResultCode(string $type, array $dataRows, string $table, ServerRequestInterface $request) : array

Parameters

$type : string
$dataRows : array
$table : string
$request : ServerRequestInterface

Tags

throws
Exception

Return values

array —

HTML-code for "header" and "content"

getQuerySingle()

protected getQuerySingle(array $conf, bool $first) : string

Parameters

$conf : array
$first : bool

Return values

string

getSelectQuery()

protected getSelectQuery([string $qString = '' ]) : string

Parameters

$qString : string = ''

Return values

string

getSubscript()

protected getSubscript(mixed $arr) : array

Parameters

$arr : mixed

Return values

array

getTreeList()

Recursively fetch all descendants of a given page

protected getTreeList(int $id, int $depth[, int $begin = 0 ][, string $permsClause = '' ]) : string

Parameters

$id : int
$depth : int
$begin : int = 0
$permsClause : string = ''

Return values

string —

comma separated list of descendant pages

init()

protected init(string $name, string $table[, string $fieldList = '' ][, array $settings = [] ]) : void

Parameters

$name : string
$table : string
$fieldList : string = ''
$settings : array = []

Module settings like checkboxes in the interface

initStoreArray()

protected initStoreArray() : array

Return values

array

isDateOfIso8601Format()

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

protected isDateOfIso8601Format(mixed $date) : bool

Parameters

$date : mixed

Return values

bool

loadStoreQueryConfigs()

protected loadStoreQueryConfigs(array $storeQueryConfigs, int $storeIndex, array $writeArray) : array

Parameters

$storeQueryConfigs : array
$storeIndex : int
$writeArray : array

Return values

array

makeComparisonSelector()

protected makeComparisonSelector(string $subscript, string $fieldName, array $conf) : string

Parameters

$subscript : string
$fieldName : string
$conf : array

Return values

string

makeFieldList()

protected makeFieldList() : string

Return values

string

makeOptionList()

protected makeOptionList(string $fieldName, array $conf, string $table) : string

Parameters

$fieldName : string
$conf : array
$table : string

Return values

string

makeSelectorTable()

protected makeSelectorTable(array $modSettings, ServerRequestInterface $request) : string

Parameters

$modSettings : array
$request : ServerRequestInterface

Return values

string

makeStoreControl()

protected makeStoreControl() : string

Return values

string

makeValueList()

protected makeValueList(string $fieldName, string $fieldValue, array $conf, string $table, string $splitString) : string

Parameters

$fieldName : string
$fieldValue : string
$conf : array
$table : string
$splitString : string

Return values

string

menuConfig()

Configure menu

protected menuConfig(ServerRequestInterface $request) : void

Parameters

$request : ServerRequestInterface

mkCompSelect()

protected mkCompSelect(string $name, int $comparison, int $neg) : string

Parameters

$name : string
$comparison : int
$neg : int

Return values

string

mkFieldToInputSelect()

protected mkFieldToInputSelect(string $name, string $fieldName) : string

Parameters

$name : string
$fieldName : string

Return values

string

mkOperatorSelect()

protected mkOperatorSelect(string $name, string $op, bool $draw, bool $submit) : string

Parameters

$name : string
$op : string
$draw : bool
$submit : bool

Return values

string

mkTableSelect()

protected mkTableSelect(string $name, string $cur) : string

Parameters

$name : string
$cur : string

Return values

string

mkTypeSelect()

protected mkTypeSelect(string $name, string $fieldName[, string $prepend = 'FIELD_' ]) : string

Parameters

$name : string
$fieldName : string
$prepend : string = 'FIELD_'

Return values

string

printCodeArray()

protected printCodeArray(array $codeArr[, int $recursionLevel = 0 ]) : string

Parameters

$codeArr : array
$recursionLevel : int = 0

Return values

string

procesData()

protected procesData(ServerRequestInterface $request[, array $qC = [] ]) : void

Parameters

$request : ServerRequestInterface
$qC : array = []

procesStoreControl()

protected procesStoreControl(ServerRequestInterface $request) : string

Parameters

$request : ServerRequestInterface

Return values

string

queryMaker()

protected queryMaker(ServerRequestInterface $request) : string

Parameters

$request : ServerRequestInterface

Return values

string

resultRowDisplay()

protected resultRowDisplay(array $row, string $table, ServerRequestInterface $request) : string

Parameters

$row : array
$table : string
$request : ServerRequestInterface

Return values

string

resultRowTitles()

protected resultRowTitles(array|null $row, string $table) : string

Parameters

$row : array|null

Table columns

$table : string

Return values

string

setAndCleanUpExternalLists()

protected setAndCleanUpExternalLists(string $name, string $list[, string $force = '' ]) : void

Parameters

$name : string
$list : string
$force : string = ''

updateIcon()

protected updateIcon() : string

Return values

string

verifyComparison()

protected verifyComparison(int $comparison, bool $neg) : int

Parameters

$comparison : int
$neg : bool

Return values

int

verifyType()

protected verifyType(string $fieldName) : string

Parameters

$fieldName : string

Return values

string
On this page