TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList Class Reference
Inheritance diagram for TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList:
TYPO3\CMS\Backend\RecordList\AbstractRecordList TYPO3\CMS\Backend\View\PageLayoutView TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList TYPO3\CMS\Dbal\RecordList\DatabaseRecordList TYPO3\CMS\SysAction\ActionList

Public Member Functions

 start ($id, $table, $pointer, $search='', $levels=0, $showLimit=0)
 
 generateList ()
 
 getTable ($tableName, $id, $fields='')
 
 setDispFields ()
 
 thumbCode ($row, $table, $field)
 
 makeQueryArray ($table, $id, $addWhere='', $fieldList=' *')
 
 setTotalItems ($queryParts)
 
 makeSearchString ($table, $currentPid=-1)
 
 linkWrapTable ($table, $code)
 
 linkWrapItems ($table, $uid, $code, $row)
 
 linkUrlMail ($code, $testString)
 
 listURL ($altId='', $table='-1', $exclList='')
 
 requestUri ()
 
 makeFieldList ($table, $dontCheckUser=false, $addDateFields=false)
 
 localizationRedirect ($justLocalized)
 
 setOverrideUrlParameters (array $urlParameters)
 
 setTableDisplayOrder (array $orderInformation)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\RecordList\AbstractRecordList
 __construct ()
 
 addElement ($h, $icon, $data, $rowParams='', $_='', $_2='', $colType='td')
 
 writeTop ()
 
 fwd_rwd_nav ($table='')
 
 fwd_rwd_HTML ($type, $pointer, $table='')
 
 listURL ($altId='', $table='-1', $exclList='')
 
 CBfunctions ()
 
 initializeLanguages ()
 
 languageFlag ($sys_language_uid, $addAsAdditionalText=true)
 

Public Attributes

 $tableList = ''
 
 $returnUrl = ''
 
 $thumbs = 0
 
 $itemsLimitPerTable = 20
 
 $itemsLimitSingleTable = 100
 
 $script = 'index.php'
 
 $allFields = 0
 
 $localizationView = false
 
 $csvOutput = false
 
 $sortField
 
 $sortRev
 
 $displayFields
 
 $duplicateField
 
 $id
 
 $table = ''
 
 $listOnlyInSingleTableMode = false
 
 $firstElementNumber = 0
 
 $searchString = ''
 
 $searchLevels = ''
 
 $showLimit = 0
 
 $pidSelect = ''
 
 $perms_clause = ''
 
 $calcPerms = 0
 
 $clickTitleMode = ''
 
 $modSharedTSconfig = []
 
 $pageRecord = []
 
 $hideTables = ''
 
 $hideTranslations = ''
 
 $tableTSconfigOverTCA = []
 
 $tablesCollapsed = []
 
 $JScode = ''
 
 $HTMLcode = ''
 
 $iLimit = 0
 
 $eCounter = 0
 
 $totalItems = ''
 
 $recPath_cache = []
 
 $setFields = []
 
 $currentTable = []
 
 $duplicateStack = []
 
 $modTSconfig
 
- Public Attributes inherited from TYPO3\CMS\Backend\RecordList\AbstractRecordList
 $iLimit = 10
 
 $leftMargin = 0
 
 $showIcon = 1
 
 $no_noWrap = 0
 
 $oddColumnsCssClass = ''
 
 $fieldArray = []
 
 $addElement_tdParams = []
 
 $addElement_tdCssClass = []
 
 $fixedL = 30
 
 $thisScript = ''
 
 $setLMargin = 1
 
 $counter = 0
 
 $totalItems = ''
 
 $firstElementNumber = 0
 
 $eCounter = 0
 
 $HTMLcode = ''
 
 $pageOverlays = []
 
 $languageIconTitles = []
 
 $translateTools
 

Protected Member Functions

 getSearchFields ($tableName)
 
 getBackendUserAuthentication ()
 
 getDatabaseConnection ()
 
- Protected Member Functions inherited from TYPO3\CMS\Backend\RecordList\AbstractRecordList
 determineScriptUrl ()
 
 getThisScript ()
 
 getTranslateTools ()
 
 generateReferenceToolTip ($references, $launchViewParameter='')
 
 getLanguageService ()
 
 getDatabaseConnection ()
 

Protected Attributes

 $overrideUrlParameters = []
 
 $tableDisplayOrder = []
 
- Protected Attributes inherited from TYPO3\CMS\Backend\RecordList\AbstractRecordList
 $id = 0
 
 $iconFactory
 

Detailed Description

Child class for rendering of Web > List (not the final class) Shared between Web>List and Web>Page

See also

Definition at line 38 of file AbstractDatabaseRecordList.php.

Member Function Documentation

◆ generateList()

◆ getBackendUserAuthentication()

◆ getDatabaseConnection()

◆ getSearchFields()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::getSearchFields (   $tableName)
protected

◆ getTable()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::getTable (   $tableName,
  $id,
  $fields = '' 
)

◆ linkUrlMail()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::linkUrlMail (   $code,
  $testString 
)

Wrapping input code in link to URL or email if $testString is either.

Parameters
string$codecode to wrap
string$testStringString which is tested for being a URL or email and which will be used for the link if so.
Returns
string Link-Wrapped $code value, if $testString was URL or email.

Definition at line 891 of file AbstractDatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow().

◆ linkWrapItems()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::linkWrapItems (   $table,
  $uid,
  $code,
  $row 
)

◆ linkWrapTable()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::linkWrapTable (   $table,
  $code 
)

Returns the title (based on $code) of a table ($table) with the proper link around. For headers over tables. The link will cause the display of all extended mode or not for the table.

Parameters
string$tableTable name
string$codeTable label
Returns
string The linked table label

Definition at line 813 of file AbstractDatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons().

◆ listURL()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::listURL (   $altId = '',
  $table = '-1',
  $exclList = '' 
)

Creates the URL to this script, including all relevant GPvars Fixed GPvars are id, table, imagemode, returnUrl, search_field, search_levels and showLimit The GPvars "sortField" and "sortRev" are also included UNLESS they are found in the $exclList variable.

Parameters
string$altIdAlternative id value. Enter blank string for the current id ($this->id)
string$tableTable name to display. Enter "-1" for the current table.
string$exclListComma separated list of fields NOT to include ("sortField", "sortRev" or "firstElementNumber")
Returns
string URL

Definition at line 916 of file AbstractDatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addSortLink(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getButtons(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getTable(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation().

◆ localizationRedirect()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::localizationRedirect (   $justLocalized)

Redirects to FormEngine if a record is just localized.

Parameters
string$justLocalizedString with table, orig uid and language separated by ":
Returns
void

Definition at line 1074 of file AbstractDatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\start().

◆ makeFieldList()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::makeFieldList (   $table,
  $dontCheckUser = false,
  $addDateFields = false 
)

Makes the list of fields to select for a table

Parameters
string$tableTable name
bool$dontCheckUserIf set, users access to the field (non-exclude-fields) is NOT checked.
bool$addDateFieldsIf set, also adds crdate and tstamp fields (note: they will also be added if user is admin or dontCheckUser is set)
Returns
string[] Array, where values are fieldnames to include in query

Definition at line 987 of file AbstractDatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\generateList(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeQueryArray().

◆ makeQueryArray()

◆ makeSearchString()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::makeSearchString (   $table,
  $currentPid = -1 
)

Creates part of query for searching after a word ($this->searchString) fields in input table.

Parameters
string$tableTable, in which the fields are being searched.
int$currentPidPage id for the possible search limit. -1 only if called from an old XCLASS.
Returns
string Returns part of WHERE-clause for searching, if applicable.

Definition at line 710 of file AbstractDatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$searchString, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getDatabaseConnection(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getSearchFields(), and TYPO3\CMS\Core\Utility\GeneralUtility\inList().

Referenced by TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeQueryArray().

◆ requestUri()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::requestUri ( )

Returns "requestUri" - which is basically listURL

Returns
string Content of ->listURL()

Definition at line 974 of file AbstractDatabaseRecordList.php.

◆ setDispFields()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::setDispFields ( )

Setting the field names to display in extended list. Sets the internal variable $this->setFields

Returns
void

Definition at line 599 of file AbstractDatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getBackendUserAuthentication().

◆ setOverrideUrlParameters()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::setOverrideUrlParameters ( array  $urlParameters)

Set URL parameters to override or add in the listUrl() method.

Parameters
string[]$urlParameters
Returns
void

Definition at line 1100 of file AbstractDatabaseRecordList.php.

◆ setTableDisplayOrder()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::setTableDisplayOrder ( array  $orderInformation)

Set table display order information

Structure of $orderInformation: 'tableName' => [ 'before' => // comma-separated string list or array of table names 'after' => // comma-separated string list or array of table names ]

Parameters
array$orderInformation
Exceptions

Definition at line 1117 of file AbstractDatabaseRecordList.php.

◆ setTotalItems()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::setTotalItems (   $queryParts)

Based on input query array (query for selecting count(*) from a table) it will select the number of records and set the value in $this->totalItems

Parameters
string[]$queryParts Query array
Returns
void
See also
makeQueryArray()

Definition at line 697 of file AbstractDatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getDatabaseConnection().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), and TYPO3\CMS\Backend\View\PageLayoutView\makeOrdinaryList().

◆ start()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::start (   $id,
  $table,
  $pointer,
  $search = '',
  $levels = 0,
  $showLimit = 0 
)

◆ thumbCode()

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::thumbCode (   $row,
  $table,
  $field 
)

Create thumbnail code for record/field

Parameters
mixed[]$row Record array
string$tableTable (record is from)
string$fieldField name for which thumbnail are to be rendered.
Returns
string HTML for thumbnails, if any.

Definition at line 623 of file AbstractDatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table.

Referenced by TYPO3\CMS\Backend\View\PageLayoutView\dataFields(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow().

Member Data Documentation

◆ $allFields

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$allFields = 0

Definition at line 87 of file AbstractDatabaseRecordList.php.

◆ $calcPerms

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$calcPerms = 0

Definition at line 200 of file AbstractDatabaseRecordList.php.

◆ $clickTitleMode

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$clickTitleMode = ''

Definition at line 207 of file AbstractDatabaseRecordList.php.

◆ $csvOutput

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$csvOutput = false

Definition at line 101 of file AbstractDatabaseRecordList.php.

◆ $currentTable

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$currentTable = []

Definition at line 305 of file AbstractDatabaseRecordList.php.

◆ $displayFields

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$displayFields

Definition at line 122 of file AbstractDatabaseRecordList.php.

◆ $duplicateField

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$duplicateField

◆ $duplicateStack

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$duplicateStack = []

Definition at line 312 of file AbstractDatabaseRecordList.php.

◆ $eCounter

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$eCounter = 0

Definition at line 277 of file AbstractDatabaseRecordList.php.

◆ $firstElementNumber

◆ $hideTables

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$hideTables = ''

Definition at line 228 of file AbstractDatabaseRecordList.php.

◆ $hideTranslations

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$hideTranslations = ''

Definition at line 235 of file AbstractDatabaseRecordList.php.

◆ $HTMLcode

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$HTMLcode = ''

Definition at line 263 of file AbstractDatabaseRecordList.php.

◆ $id

◆ $iLimit

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$iLimit = 0

◆ $itemsLimitPerTable

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$itemsLimitPerTable = 20

Definition at line 66 of file AbstractDatabaseRecordList.php.

◆ $itemsLimitSingleTable

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$itemsLimitSingleTable = 100

◆ $JScode

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$JScode = ''

Definition at line 256 of file AbstractDatabaseRecordList.php.

◆ $listOnlyInSingleTableMode

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$listOnlyInSingleTableMode = false

◆ $localizationView

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$localizationView = false

Definition at line 94 of file AbstractDatabaseRecordList.php.

◆ $modSharedTSconfig

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$modSharedTSconfig = []

◆ $modTSconfig

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$modTSconfig

Definition at line 317 of file AbstractDatabaseRecordList.php.

◆ $overrideUrlParameters

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$overrideUrlParameters = []
protected

Definition at line 323 of file AbstractDatabaseRecordList.php.

◆ $pageRecord

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$pageRecord = []

Definition at line 221 of file AbstractDatabaseRecordList.php.

◆ $perms_clause

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$perms_clause = ''

Definition at line 193 of file AbstractDatabaseRecordList.php.

◆ $pidSelect

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$pidSelect = ''

Definition at line 186 of file AbstractDatabaseRecordList.php.

◆ $recPath_cache

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$recPath_cache = []

Definition at line 291 of file AbstractDatabaseRecordList.php.

◆ $returnUrl

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$returnUrl = ''

◆ $script

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$script = 'index.php'

Definition at line 80 of file AbstractDatabaseRecordList.php.

◆ $searchLevels

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$searchLevels = ''

◆ $searchString

◆ $setFields

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$setFields = []

◆ $showLimit

◆ $sortField

◆ $sortRev

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$sortRev

◆ $table

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$table = ''

Definition at line 143 of file AbstractDatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addSortLink(), TYPO3\CMS\Backend\View\PageLayoutView\dataFields(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Backend\View\PageLayoutView\generateListForCTypeMenu(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Backend\View\PageLayoutView\getExternalTables(), TYPO3\CMS\Backend\View\PageLayoutView\getIcon(), TYPO3\CMS\Backend\View\PageLayoutView\getProcessedValue(), TYPO3\CMS\Backend\View\PageLayoutView\getResult(), TYPO3\CMS\Backend\View\PageLayoutView\getTable(), TYPO3\CMS\Backend\View\PageLayoutView\getThumbCodeUnlinked(), TYPO3\CMS\Backend\View\PageLayoutView\headerFields(), TYPO3\CMS\Backend\View\PageLayoutView\isDisabled(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isEditable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRecordCurrentBackendUser(), TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList\isRowListingConditionFulfilled(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkClipboardHeaderIcon(), TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapTable(), TYPO3\CMS\SysAction\ActionList\listURL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeClip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Backend\View\PageLayoutView\makeOrdinaryList(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeQueryArray(), TYPO3\CMS\Dbal\RecordList\DatabaseRecordList\makeSearchString(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeSearchString(), TYPO3\CMS\Backend\View\PageLayoutView\numberOfRecords(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\overlayEditLockPermissions(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showNewRecLink(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\start(), and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\thumbCode().

◆ $tableDisplayOrder

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$tableDisplayOrder = []
protected

Definition at line 334 of file AbstractDatabaseRecordList.php.

◆ $tableList

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$tableList = ''

Definition at line 45 of file AbstractDatabaseRecordList.php.

◆ $tablesCollapsed

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$tablesCollapsed = []

◆ $tableTSconfigOverTCA

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$tableTSconfigOverTCA = []

Definition at line 242 of file AbstractDatabaseRecordList.php.

◆ $thumbs

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$thumbs = 0

◆ $totalItems

TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList::$totalItems = ''