QueryView
Class used in module tools/dbint (advanced search) and which may hold code specific for that module However the class has a general principle in it which may be used in the web/export module.
since v11, will be removed in v12
Table of Contents
Properties
- $hookArray : array<string|int, mixed>
- $noDownloadB : int
- $storeList : string
- $backendUserAuthentication : BackendUserAuthentication
- $formName : string
- $iconFactory : IconFactory
- $languageService : LanguageService
- $menuItems : array<string|int, mixed>
- $moduleName : string
- $settings : array<string|int, mixed>
- Settings, usually from the controller (previously known from $GLOBALS['SOBE']->MOD_SETTINGS
- $tableArray : array<string|int, mixed>
Methods
- __construct() : mixed
- addToStoreQueryConfigs() : array<string|int, mixed>
- Add to store query configs
- cleanStoreQueryConfigs() : array<string|int, mixed>
- Clean store query configs
- csvRowTitles() : string
- CSV row titles
- csvValues() : string
- CSV values
- form() : string
- Get form
- getProcessedValueExtra() : string
- Get processed value extra
- getQueryResultCode() : array<string|int, mixed>
- Get query result code
- getTreeList() : string
- Get tree list
- initStoreArray() : array<string|int, mixed>
- Init store array
- loadStoreQueryConfigs() : array<string|int, mixed>
- Load store query configs
- makeStoreControl() : string
- Make store control
- makeValueList() : string
- Make value list
- procesStoreControl() : string
- Process store control
- queryMaker() : string
- Query marker
- resultRowDisplay() : string
- Result row display
- resultRowTitles() : string
- Render table header
- saveQueryInAction() : int
- Save query in action
- search() : string
- Search
- setFormName() : mixed
- Sets the current name of the input form.
Properties
$hookArray
public
array<string|int, mixed>
$hookArray
= []
$noDownloadB
public
int
$noDownloadB
= 0
$storeList
public
string
$storeList
= 'search_query_smallparts,search_result_labels,labels_noprefix,show_deleted,queryConfig,queryTable,queryFields,queryLimit,queryOrder,queryOrderDesc,queryOrder2,queryOrder2Desc,queryGroup,search_query_makeQuery'
$backendUserAuthentication
protected
BackendUserAuthentication
$backendUserAuthentication
$formName
protected
string
$formName
= ''
$iconFactory
protected
IconFactory
$iconFactory
$languageService
protected
LanguageService
$languageService
$menuItems
protected
array<string|int, mixed>
$menuItems
= []
information on the menu of this module
$moduleName
protected
string
$moduleName
$settings
Settings, usually from the controller (previously known from $GLOBALS['SOBE']->MOD_SETTINGS
protected
array<string|int, mixed>
$settings
= []
$tableArray
protected
array<string|int, mixed>
$tableArray
= []
Methods
__construct()
public
__construct([array<string|int, mixed>|null $settings = null ][, array<string|int, mixed>|null $menuItems = null ][, string|null $moduleName = null ]) : mixed
Parameters
- $settings : array<string|int, mixed>|null = null
-
previously stored in $GLOBALS['SOBE']->MOD_SETTINGS
- $menuItems : array<string|int, mixed>|null = null
-
previously stored in $GLOBALS['SOBE']->MOD_MENU
- $moduleName : string|null = null
-
previously stored in $GLOBALS['SOBE']->moduleName
addToStoreQueryConfigs()
Add to store query configs
public
addToStoreQueryConfigs(array<string|int, mixed> $storeQueryConfigs, int $index) : array<string|int, mixed>
Parameters
- $storeQueryConfigs : array<string|int, mixed>
- $index : int
Return values
array<string|int, mixed>cleanStoreQueryConfigs()
Clean store query configs
public
cleanStoreQueryConfigs(array<string|int, mixed> $storeQueryConfigs, array<string|int, mixed> $storeArray) : array<string|int, mixed>
Parameters
- $storeQueryConfigs : array<string|int, mixed>
- $storeArray : array<string|int, mixed>
Return values
array<string|int, mixed>csvRowTitles()
CSV row titles
public
csvRowTitles(array<string|int, mixed> $row, array<string|int, mixed> $conf) : string
Parameters
- $row : array<string|int, mixed>
- $conf : array<string|int, mixed>
Tags
Return values
stringcsvValues()
CSV values
public
csvValues(array<string|int, mixed> $row[, string $delim = ',' ][, string $quote = '"' ][, array<string|int, mixed> $conf = [] ][, string $table = '' ]) : string
Parameters
- $row : array<string|int, mixed>
- $delim : string = ','
- $quote : string = '"'
- $conf : array<string|int, mixed> = []
- $table : string = ''
Return values
string —A single line of CSV
form()
Get form
public
form() : string
Return values
stringgetProcessedValueExtra()
Get processed value extra
public
getProcessedValueExtra(string $table, string $fieldName, string $fieldValue, array<string|int, mixed> $conf, string $splitString) : string
Parameters
- $table : string
- $fieldName : string
- $fieldValue : string
- $conf : array<string|int, mixed>
-
Not used
- $splitString : string
Return values
stringgetQueryResultCode()
Get query result code
public
getQueryResultCode(string $type, array<string|int, mixed> $dataRows, string $table) : array<string|int, mixed>
Parameters
- $type : string
- $dataRows : array<string|int, mixed>
-
Rows to display
- $table : string
Tags
Return values
array<string|int, mixed> —HTML-code for "header" and "content"
getTreeList()
Get tree list
public
getTreeList(int $id, int $depth[, int $begin = 0 ][, string $permsClause = null ]) : string
Parameters
- $id : int
- $depth : int
- $begin : int = 0
- $permsClause : string = null
Return values
stringinitStoreArray()
Init store array
public
initStoreArray() : array<string|int, mixed>
Return values
array<string|int, mixed>loadStoreQueryConfigs()
Load store query configs
public
loadStoreQueryConfigs(array<string|int, mixed> $storeQueryConfigs, int $storeIndex, array<string|int, mixed> $writeArray) : array<string|int, mixed>
Parameters
- $storeQueryConfigs : array<string|int, mixed>
- $storeIndex : int
- $writeArray : array<string|int, mixed>
Return values
array<string|int, mixed>makeStoreControl()
Make store control
public
makeStoreControl() : string
Return values
stringmakeValueList()
Make value list
public
makeValueList(string $fieldName, string $fieldValue, array<string|int, mixed> $conf, string $table, string $splitString) : string
Parameters
- $fieldName : string
- $fieldValue : string
- $conf : array<string|int, mixed>
- $table : string
- $splitString : string
Return values
stringprocesStoreControl()
Process store control
public
procesStoreControl() : string
Return values
stringqueryMaker()
Query marker
public
queryMaker() : string
Return values
stringresultRowDisplay()
Result row display
public
resultRowDisplay(array<string|int, mixed> $row, array<string|int, mixed> $conf, string $table) : string
Parameters
- $row : array<string|int, mixed>
- $conf : array<string|int, mixed>
- $table : string
Return values
stringresultRowTitles()
Render table header
public
resultRowTitles(array<string|int, mixed> $row, array<string|int, mixed> $conf) : string
Parameters
- $row : array<string|int, mixed>
-
Table columns
- $conf : array<string|int, mixed>
-
Table TCA
Return values
string —HTML of table header
saveQueryInAction()
Save query in action
public
saveQueryInAction(int $uid) : int
Parameters
- $uid : int
Return values
intsearch()
Search
public
search() : string
Return values
stringsetFormName()
Sets the current name of the input form.
public
setFormName(string $formName) : mixed
Parameters
- $formName : string
-
The name of the form.