‪TYPO3CMS  10.4
TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList Class Reference
Inheritance diagram for TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList:
TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList

Public Member Functions

 __construct ()
 
 getDocHeaderButtons (ModuleTemplate $moduleTemplate)
 
string getTable ($table, $id, $rowList='')
 
string renderListRow ($table, $row, $cc, $titleCol, $thumbsCol, $indent=0)
 
string renderListHeader ($table, $currentIdList)
 
string makeControl ($table, $row)
 
string makeClip ($table, $row)
 
string[] makeLocalizationPanel ($table, $row)
 
string fieldSelectBox ($table, $formFields=true)
 
string linkClipboardHeaderIcon ($string, $table, $cmd, $warning='', $title='')
 
bool clipNumPane ()
 
string addSortLink ($code, $field, $table)
 
mixed[] recPath ($pid)
 
bool showNewRecLink ($table)
 
string makeReturnUrl ()
 
 setCsvRow ($csvRow)
 
 outputCSV ($prefix)
 
 addActionToCellGroup (&$cells, $action, $actionKey)
 
 setIsEditable (bool $isEditable)
 
bool isEditable (string $table)
 
 setModuleData (array $moduleData=[])
 
 start ($id, $table, $pointer, $search='', $levels=0, $showLimit=0)
 
 generateList ()
 
string getSearchBox ($formFields=true)
 
 setDispFields ()
 
TYPO3 CMS Core Database Query QueryBuilder getQueryBuilder (string $table, int $pageId, array $additionalConstraints=[], array $fields=[' *'])
 
 setTotalItems (string $table, int $pageId, array $constraints)
 
string makeSearchString ($table, $currentPid=-1)
 
string linkWrapTable ($table, $code)
 
string linkWrapItems ($table, $uid, $code, $row)
 
string linkUrlMail ($code, $testString)
 
string listURL ($altId='', $table='-1', $exclList='')
 
string[] makeFieldList ($table, $dontCheckUser=false, $addDateFields=false)
 
 setOverrideUrlParameters (array $urlParameters)
 
 setTableDisplayOrder (array $orderInformation)
 
array getOverridePageIdList ()
 
 setOverridePageIdList (array $overridePageIdList)
 
string addElement ($h, $icon, $data, $rowParams='', $_='', $_2='', $colType='td')
 
 initializeLanguages ()
 
string languageFlag ($sys_language_uid, $addAsAdditionalText=true)
 
 showOnlyTranslatedRecords (bool $showOnlyTranslatedRecords)
 
DatabaseRecordList setLanguagesAllowedForUser (array $languagesAllowedForUser)
 

Public Attributes

string[] $allowedNewTables = array( )
 
string[] $deniedNewTables = array( )
 
bool $dontShowClipControlPanels = false
 
bool $showClipboard = false
 
bool $noControlPanels = false
 
bool $clickMenuEnabled = true
 
int $totalRowCount
 
string $spaceIcon
 
bool $disableSingleTableView = false
 
string[] $pageRow = array( )
 
array $pageOverlays = array( )
 
array $languageIconTitles = array( )
 
string $hideTranslations = ''
 
bool $csvOutput = false
 
mixed[] $recPath_cache = array( )
 
string $sortField
 
int $itemsLimitPerTable = 20
 
array $addElement_tdParams = array( )
 
int $id
 
string[] $duplicateStack = array( )
 
string $script = 'index.php'
 
bool $listOnlyInSingleTableMode = false
 
string $thisScript = ''
 
TranslationConfigurationProvider $translateTools
 
int $itemsLimitSingleTable = 100
 
int[][] $tablesCollapsed = array( )
 
array[] $modTSconfig
 
string $HTMLcode = ''
 
array $addElement_tdCssClass = array( )
 
bool $thumbs = false
 
int[][] $currentTable = array( )
 
int $allFields = 0
 
int $showLimit = 0
 
array $fieldArray = array( )
 
string $hideTables = ''
 
string[] $displayFields
 
string $oddColumnsCssClass = ''
 
int $fixedL = 30
 
string $perms_clause = ''
 
string $returnUrl = ''
 
string $table = ''
 
int $calcPerms = 0
 
string $clickTitleMode = ''
 
int $showIcon = 1
 
int $searchLevels = 0
 
int $iLimit = 0
 
string $totalItems = ''
 
mixed[][] $tableTSconfigOverTCA = array( )
 
string[] $pageRecord = array( )
 
string[] $setFields = array( )
 
int $counter = 0
 
int $firstElementNumber = 0
 
int $eCounter = 0
 
string $searchString = ''
 
bool $sortRev
 
string $duplicateField
 
string $tableList = ''
 
TYPO3 CMS Backend Clipboard Clipboard $clipObj
 
string[] $CBnames = array( )
 
string[] $translations
 
string $selFieldList
 
mixed[] $pageinfo
 
string[] $MOD_MENU
 

Protected Member Functions

string getOnClickForRow (string $table, array $row)
 
bool isRowListingConditionFulfilled ($table, $row)
 
int getReferenceCount ($tableName, $uid)
 
int getPointerForPage ($page)
 
string renderListNavigation ($renderPart='top')
 
 initCSV ()
 
 addHeaderRowToCSV ()
 
 addToCSV (array $row=[])
 
bool isRecordCurrentBackendUser ($table, $row)
 
 isRecordDeletePlaceholder (array $row)
 
bool overlayEditLockPermissions ($table, $row=[], $editPermission=true)
 
bool editLockPermissions ()
 
QueryBuilder prepareQueryBuilder (string $table, int $pageId, array $fieldList=[' *'], array $additionalConstraints=[], QueryBuilder $queryBuilder, bool $addSorting=true)
 
string[] getSearchFields ($tableName)
 
int[] getSearchableWebmounts ($id, $depth, $perms_clause)
 
QueryBuilder addPageIdConstraint (string $tableName, QueryBuilder $queryBuilder)
 
BackendUserAuthentication getBackendUserAuthentication ()
 
 determineScriptUrl ()
 
string getThisScript ()
 
TranslationConfigurationProvider getTranslateTools ()
 
 generateReferenceToolTip (string $table, int $uid)
 
string createShowItemTagAttributes (string $arguments)
 
string getVisibleColumns (array $tableTCA, string $type)
 
LanguageService getLanguageService ()
 
array getNoViewWithDokTypes (array $tsConfig)
 

Static Protected Member Functions

static mixed[] removeControlFieldsFromFieldRow (array $row=[])
 

Protected Attributes

array $moduleData = array( )
 
string[] $csvLines = array( )
 
int[][] $referenceCount = array( )
 
bool $editable = true
 
IconFactory $iconFactory
 
UriBuilder $uriBuilder
 
array[] $tableDisplayOrder = array( )
 
array $overridePageIdList = array( )
 
mixed[] $overrideUrlParameters = array( )
 
array $currentLink = array( )
 
bool $showOnlyTranslatedRecords = false
 
array $systemLanguagesOnPage
 
array $languagesAllowedForUser = array( )
 

Detailed Description

Class for rendering of Web>List module

This class is a specific TYPO3 Backend implementation and is not part of the TYPO3's Core API.

Definition at line 56 of file DatabaseRecordList.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::__construct ( )

Member Function Documentation

◆ addActionToCellGroup()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::addActionToCellGroup ( $cells,
  $action,
  $actionKey 
)

add action into correct section

Parameters
array$cells
string$action
string$actionKey

Definition at line 2632 of file DatabaseRecordList.php.

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

◆ addElement()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::addElement (   $h,
  $icon,
  $data,
  $rowParams = '',
  $_ = '',
  $_2 = '',
  $colType = 'td' 
)

Returns a table-row with the content from the fields in the input data array. OBS: $this->fieldArray MUST be set! (represents the list of fields to display)

Parameters
int$h‪Is an integer >=0 and denotes how tall an element is. Set to '0' makes a half line, -1 = full line, set to 1 makes a 'join' and above makes 'line'
string$icon‪Is the + of the record. If not supplied the first 'join'-icon will be a 'line' instead
array$data‪Is the data array, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in

-tags

Parameters
string$rowParams‪Is insert in the

-tags. Must carry a ' ' as first character

Parameters
string$_‪OBSOLETE - NOT USED ANYMORE. $lMargin is the leftMargin (int)
string$_2‪OBSOLETE - NOT USED ANYMORE. Is the HTML -tag for an alternative 'gfx/ol/line.gif'-icon (used in the top)
string$colType‪Defines the tag being used for the columns. Default is td.
Returns
‪string HTML content for the table row

Definition at line 3793 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$fieldArray, and $fields.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow().

◆ addHeaderRowToCSV()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::addHeaderRowToCSV ( )
protected

◆ addPageIdConstraint()

◆ addSortLink()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::addSortLink (   $code,
  $field,
  $table 
)

Creates a sort-by link on the input string ($code). It will automatically detect if sorting should be ascending or descending depending on $this->sortRev. Also some fields will not be possible to sort (including if single-table-view is disabled).

Parameters
string$code‪The string to link (text)
string$field‪The fieldname represented by the title ($code)
string$table‪Table name
Returns
‪string Linked $code variable

Definition at line 2458 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ addToCSV()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::addToCSV ( array  $row = [])
protected

Adds selected columns of one table row as CSV line.

Parameters
mixed[]$row‪Record array, from which the values of fields found in $this->fieldArray will be listed in the CSV output.

Definition at line 2560 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$fieldArray, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\removeControlFieldsFromFieldRow(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\setCsvRow().

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

◆ clipNumPane()

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::clipNumPane ( )

Returns TRUE if a numeric clipboard pad is selected/active

Returns
‪bool

Definition at line 2443 of file DatabaseRecordList.php.

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

◆ createShowItemTagAttributes()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::createShowItemTagAttributes ( string  $arguments)
protected

Creates data attributes to be handles in moddule TYPO3/CMS/Backend/ActionDispatcher

Parameters
string$arguments
Returns
‪string

Definition at line 4007 of file DatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\generateReferenceToolTip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapItems(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl().

◆ determineScriptUrl()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::determineScriptUrl ( )
protected

Sets the script url depending on being a module or script request

Definition at line 3936 of file DatabaseRecordList.php.

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

◆ editLockPermissions()

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::editLockPermissions ( )
protected

Check whether or not the current backend user is an admin or the current page is locked by editlock.

Returns
‪bool

Definition at line 2722 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin().

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

◆ fieldSelectBox()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::fieldSelectBox (   $table,
  $formFields = true 
)

Creates a checkbox list for selecting fields to display from a table:

Parameters
string$table‪Table name
bool$formFields‪If TRUE, form-fields will be wrapped around the table.
Returns
‪string HTML table with the selector check box (name: displayFields['.$table.'][])

Definition at line 2313 of file DatabaseRecordList.php.

References $fields, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$setFields, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Backend\Utility\BackendUtility\getItemLabel(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeFieldList().

◆ generateList()

◆ generateReferenceToolTip()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::generateReferenceToolTip ( string  $table,
int  $uid 
)
protected

◆ getBackendUserAuthentication()

BackendUserAuthentication TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getBackendUserAuthentication ( )
protected

◆ getDocHeaderButtons()

◆ getLanguageService()

◆ getNoViewWithDokTypes()

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getNoViewWithDokTypes ( array  $tsConfig)
protected

◆ getOnClickForRow()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getOnClickForRow ( string  $table,
array  $row 
)
protected

◆ getOverridePageIdList()

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getOverridePageIdList ( )

◆ getPointerForPage()

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getPointerForPage (   $page)
protected

Get pointer for first element on the page

Parameters
int$page‪Page number starting with 1
Returns
‪int Pointer to first element on the page (starting with 0)

Definition at line 1608 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$iLimit.

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

◆ getQueryBuilder()

TYPO3 CMS Core Database Query QueryBuilder TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getQueryBuilder ( string  $table,
int  $pageId,
array  $additionalConstraints = [],
array  $fields = ['*'] 
)

Returns a QueryBuilder configured to select $fields from $table where the pid is restricted depending on the current searchlevel setting.

Parameters
string$table‪Table name
int$pageId‪Page id Only used to build the search constraints, getPageIdConstraint() used for restrictions
string[]$additionalConstraints‪Additional part for where clause
string[]$fields‪Field list to select, * for all
Returns
‪\TYPO3\CMS\Core\Database\Query\QueryBuilder

Definition at line 3057 of file DatabaseRecordList.php.

References $fields, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Core\Database\Query\Restriction\QueryRestrictionContainerInterface\add(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Core\Database\Query\QueryBuilder\getRestrictions(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), and TYPO3\CMS\Core\Database\Query\Restriction\QueryRestrictionContainerInterface\removeAll().

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

◆ getReferenceCount()

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getReferenceCount (   $tableName,
  $uid 
)
protected

Gets the number of records referencing the record with the UID $uid in the table $tableName.

Parameters
string$tableName
int$uid
Returns
‪int The number of references to record $uid in table

Definition at line 1340 of file DatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\generateReferenceToolTip(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl().

◆ getSearchableWebmounts()

int [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getSearchableWebmounts (   $id,
  $depth,
  $perms_clause 
)
protected

Get all allowed mount pages to be searched in.

Parameters
int$id‪Page id
int$depth‪Depth to go down
string$perms_clause‪select clause
Returns
‪int[]

Definition at line 3683 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$perms_clause, and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication().

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

◆ getSearchBox()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getSearchBox (   $formFields = true)

◆ getSearchFields()

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getSearchFields (   $tableName)
protected

◆ getTable()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getTable (   $table,
  $id,
  $rowList = '' 
)

Creates the listing of records from a single table

Parameters
string$table‪Table name
int$id‪Page id
string$rowList‪List of fields to show in the listing. Pseudo fields will be added including the record header.
Exceptions

Definition at line 688 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$fieldArray, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$firstElementNumber, $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$itemsLimitSingleTable, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$listOnlyInSingleTableMode, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$selFieldList, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$sortField, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$totalItems, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\initCSV(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRowListingConditionFulfilled(), TYPO3\CMS\Backend\Utility\BackendUtility\isTableWorkspaceEnabled(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeFieldList(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\outputCSV(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\setTotalItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showOnlyTranslatedRecords(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING, TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

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

◆ getThisScript()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getThisScript ( )
protected
Returns
‪string

Definition at line 3948 of file DatabaseRecordList.php.

◆ getTranslateTools()

TranslationConfigurationProvider TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getTranslateTools ( )
protected

◆ getVisibleColumns()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getVisibleColumns ( array  $tableTCA,
string  $type 
)
protected

Flatten palettes into types showitem

By replacing the palettes in showitem of a TCA type with each palette content, the fields within a palette can be considered as visible database columns for a backend form.

Parameters
array$tableTCA
string$type
Returns
‪string

Definition at line 4025 of file DatabaseRecordList.php.

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

◆ initCSV()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::initCSV ( )
protected

Initializes internal csvLines array with the header of field names

Definition at line 2530 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addHeaderRowToCSV().

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

◆ initializeLanguages()

◆ isEditable()

◆ isRecordCurrentBackendUser()

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::isRecordCurrentBackendUser (   $table,
  $row 
)
protected

Check if the record represents the current backend user

Parameters
string$table
array$row
Returns
‪bool

Definition at line 2654 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication().

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

◆ isRecordDeletePlaceholder()

◆ isRowListingConditionFulfilled()

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::isRowListingConditionFulfilled (   $table,
  $row 
)
protected

Check if all row listing conditions are fulfilled.

This function serves as a dummy method to be overridden in extending classes.

Parameters
string$table‪Table name
string[]$row‪Record
Returns
‪bool True, if all conditions are fulfilled.

Reimplemented in TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList.

Definition at line 1129 of file DatabaseRecordList.php.

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

◆ languageFlag()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::languageFlag (   $sys_language_uid,
  $addAsAdditionalText = true 
)

Return the icon for the language

Parameters
int$sys_language_uid‪Sys language uid
bool$addAsAdditionalText‪If set to true, only the flag is returned
Returns
‪string Language icon

Definition at line 3914 of file DatabaseRecordList.php.

References TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider\getSystemLanguages(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getTranslateTools(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

◆ linkClipboardHeaderIcon()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::linkClipboardHeaderIcon (   $string,
  $table,
  $cmd,
  $warning = '',
  $title = '' 
)

Creates a link around $string. The link contains an onclick action which submits the script with some clipboard action. Currently, this is used for setting elements / delete elements.

Parameters
string$string‪The HTML content to link (image/text)
string$table‪Table name
string$cmd‪Clipboard command (eg. "setCB" or "delete")
string$warning‪Warning text, if any ("delete" uses this for confirmation
string$title‪title attribute for the anchor
Returns
‪string HTML tag wrapped link.

Definition at line 2409 of file DatabaseRecordList.php.

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

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

◆ linkUrlMail()

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

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

Parameters
string$code‪code to wrap
string$testString‪String 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 3467 of file DatabaseRecordList.php.

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

◆ linkWrapItems()

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

Returns the title (based on $code) of a record (from table $table) with the proper link around (that is for 'pages'-records a link to the level of that record...)

Parameters
string$table‪Table name
int$uid‪Item uid
string$code‪Item title (not htmlspecialchars()'ed yet)
mixed[]$row‪Item row
Returns
‪string The item title. Ready for HTML output (is htmlspecialchars()'ed)

Reimplemented in TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList.

Definition at line 3391 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Core\Authentication\BackendUserAuthentication\calcPerms(), TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\createShowItemTagAttributes(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getOnClickForRow(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isEditable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkUrlMail(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeReturnUrl(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT.

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

◆ linkWrapTable()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::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$table‪Table name
string$code‪Table label
Returns
‪string The linked table label

Definition at line 3370 of file DatabaseRecordList.php.

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

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

◆ listURL()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::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$altId‪Alternative id value. Enter blank string for the current id ($this->id)
string$table‪Table name to display. Enter "-1" for the current table.
string$exclList‪Comma separated list of fields NOT to include ("sortField", "sortRev" or "firstElementNumber")
Returns
‪string URL

Definition at line 3492 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$firstElementNumber, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$returnUrl, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$searchLevels, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$searchString, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$showLimit, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$sortField, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$sortRev, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$thumbs, and TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addSortLink(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getSearchBox(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation().

◆ makeClip()

◆ makeControl()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::makeControl (   $table,
  $row 
)

Creates the control panel for a single record in the listing.

Parameters
string$table‪The table
mixed[]$row‪The record for which to make the control panel.
Exceptions

Definition at line 1732 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$id, $output, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$spaceIcon, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addActionToCellGroup(), TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\createShowItemTagAttributes(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getLinkToDataHandlerAction(), TYPO3\CMS\Core\Localization\LanguageService\getLL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getNoViewWithDokTypes(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getOnClickForRow(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getReferenceCount(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isEditable(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRecordCurrentBackendUser(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRecordDeletePlaceholder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeReturnUrl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\overlayEditLockPermissions(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_DELETE, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_NEW, TYPO3\CMS\Backend\Utility\BackendUtility\referenceCount(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showNewRecLink(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Utility\BackendUtility\translationCount().

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

◆ makeFieldList()

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::makeFieldList (   $table,
  $dontCheckUser = false,
  $addDateFields = false 
)

Makes the list of fields to select for a table

Parameters
string$table‪Table name
bool$dontCheckUser‪If set, users access to the field (non-exclude-fields) is NOT checked.
bool$addDateFields‪If 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 3548 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), and TYPO3\CMS\Backend\Utility\BackendUtility\isTableWorkspaceEnabled().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\generateList(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getTable(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder().

◆ makeLocalizationPanel()

◆ makeReturnUrl()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::makeReturnUrl ( )

Creates the "&returnUrl" parameter for links - this is used when the script links to other scripts and passes its own URL with the link so other scripts can return to the listing again. Uses REQUEST_URI as value.

Returns
‪string

Definition at line 2517 of file DatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader().

◆ makeSearchString()

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

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

Parameters
string$table‪Table, in which the fields are being searched.
int$currentPid‪Page 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 3227 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getSearchFields(), and TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

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

◆ outputCSV()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::outputCSV (   $prefix)

Compiles the internal csvLines array to a csv-string and outputs it to the browser. This function exits!

Parameters
string$prefix‪Filename prefix:

Definition at line 2609 of file DatabaseRecordList.php.

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

◆ overlayEditLockPermissions()

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::overlayEditLockPermissions (   $table,
  $row = [],
  $editPermission = true 
)
protected

Check if the current record is locked by editlock. Pages are locked if their editlock flag is set, records are if they are locked themselves or if the page they are on is locked (a page’s editlock is transitive for its content elements).

Parameters
string$table
array$row
bool$editPermission
Returns
‪bool

Definition at line 2700 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeClip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader().

◆ prepareQueryBuilder()

QueryBuilder TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::prepareQueryBuilder ( string  $table,
int  $pageId,
array  $fieldList = ['*'],
array  $additionalConstraints = [],
QueryBuilder  $queryBuilder,
bool  $addSorting = true 
)
protected

Return the modified QueryBuilder object ($queryBuilder) which will be used to select the records from a table $table with pid = $this->pidList

Parameters
string$table‪Table name
int$pageId‪Page id Only used to build the search constraints, $this->pidList is used for restrictions
string[]$fieldList‪List of fields to select from the table
string[]$additionalConstraints‪Additional part for where clause
QueryBuilder$queryBuilder
bool$addSorting
Returns
‪QueryBuilder

Definition at line 3094 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Core\Database\Query\QueryBuilder\addOrderBy(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addPageIdConstraint(), TYPO3\CMS\Core\Database\Query\QueryBuilder\andWhere(), TYPO3\CMS\Core\Database\Query\QueryBuilder\createNamedParameter(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\eq(), TYPO3\CMS\Core\Database\Query\QueryBuilder\expr(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeFieldList(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeSearchString(), TYPO3\CMS\Core\Database\Query\QueryBuilder\orderBy(), TYPO3\CMS\Core\Database\Query\QueryHelper\parseOrderBy(), TYPO3\CMS\Core\Database\Query\QueryBuilder\setFirstResult(), TYPO3\CMS\Core\Database\Query\QueryBuilder\setMaxResults(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showOnlyTranslatedRecords().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getQueryBuilder(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\setTotalItems().

◆ recPath()

mixed [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::recPath (   $pid)

Returns the path for a certain pid The result is cached internally for the session, thus you can call this function as much as you like without performance problems.

Parameters
int$pid‪The page id for which to get the path
Returns
‪mixed[] The path.

Definition at line 2486 of file DatabaseRecordList.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getRecordPath().

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

◆ removeControlFieldsFromFieldRow()

static mixed [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::removeControlFieldsFromFieldRow ( array  $row = [])
staticprotected

Remove control fields from row for CSV export

Parameters
mixed[]$row‪fieldNames => fieldValues
Returns
‪mixed[] Input array reduces by control fields

Definition at line 2576 of file DatabaseRecordList.php.

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

◆ renderListHeader()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::renderListHeader (   $table,
  $currentIdList 
)

◆ renderListNavigation()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::renderListNavigation (   $renderPart = 'top')
protected

◆ renderListRow()

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::renderListRow (   $table,
  $row,
  $cc,
  $titleCol,
  $thumbsCol,
  $indent = 0 
)

Rendering a single row for the list

Parameters
string$table‪Table name
mixed[]$row‪Current record
int$cc‪Counter, counting for each time an element is rendered (used for alternating colors)
string$titleCol‪Table field (column) where header value is found
string$thumbsCol‪Table field (column) where (possible) thumbnails can be found
int$indent‪Indent from left.
Returns
‪string Table row for the element
See also
getTable()

Definition at line 1147 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addElement(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addToCSV(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\generateReferenceToolTip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getProcessedValueExtra(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordToolTip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getVisibleColumns(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRecordDeletePlaceholder(), TYPO3\CMS\Backend\Utility\BackendUtility\isRecordLocked(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkUrlMail(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeClip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\recPath(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Backend\Utility\BackendUtility\thumbCode(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapClickMenuOnIcon().

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

◆ setCsvRow()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setCsvRow (   $csvRow)

Adds input row of values to the internal csvLines array as a CSV formatted line

Parameters
mixed[]$csvRow‪Array with values to be listed.

Definition at line 2595 of file DatabaseRecordList.php.

References TYPO3\CMS\Core\Utility\CsvUtility\csvValues().

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

◆ setDispFields()

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

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

Definition at line 3031 of file DatabaseRecordList.php.

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

◆ setIsEditable()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setIsEditable ( bool  $isEditable)
Parameters
bool$isEditable

Definition at line 2672 of file DatabaseRecordList.php.

◆ setLanguagesAllowedForUser()

DatabaseRecordList TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setLanguagesAllowedForUser ( array  $languagesAllowedForUser)
Parameters
array$languagesAllowedForUser
Returns
DatabaseRecordList

Definition at line 4057 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$languagesAllowedForUser.

◆ setModuleData()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setModuleData ( array  $moduleData = [])

Set the module data

See BackendUtility::getModuleData

Parameters
array$moduleData

Definition at line 2734 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$moduleData.

◆ setOverridePageIdList()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setOverridePageIdList ( array  $overridePageIdList)
Parameters
int[] | array$overridePageIdList

Definition at line 3670 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$overridePageIdList.

◆ setOverrideUrlParameters()

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

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

Parameters
string[]$urlParameters

Definition at line 3611 of file DatabaseRecordList.php.

◆ setTableDisplayOrder()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::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 3632 of file DatabaseRecordList.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ setTotalItems()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setTotalItems ( string  $table,
int  $pageId,
array  $constraints 
)

Executed a query to set $this->totalItems to the number of total items, eg. for pagination

Parameters
string$table‪Table name
int$pageId‪Only used to build the search constraints, $this->pidList is used for restrictions
array$constraints‪Additional constraints for where clause

Definition at line 3193 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder().

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

◆ showNewRecLink()

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::showNewRecLink (   $table)

Returns TRUE if a link for creating new records should be displayed for $table

Parameters
string$table‪Table name
Returns
‪bool Returns TRUE if a link for creating new records should be displayed for $table

Definition at line 2500 of file DatabaseRecordList.php.

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

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader().

◆ showOnlyTranslatedRecords()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::showOnlyTranslatedRecords ( bool  $showOnlyTranslatedRecords)

◆ start()

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

Initializes the list generation

Parameters
int$id‪Page id for which the list is rendered. Must be >= 0
string$table‪Tablename - if extended mode where only one table is listed at a time.
int$pointer‪Browsing pointer.
string$search‪Search word, if any
int$levels‪Number of levels to search down the page tree
int$showLimit‪Limit of records to be listed.

Definition at line 2749 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$showLimit, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$tableList, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\initializeLanguages(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Member Data Documentation

◆ $addElement_tdCssClass

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$addElement_tdCssClass = array( )

Keys are fieldnames and values are td-css-classes to add in addElement();

Definition at line 243 of file DatabaseRecordList.php.

◆ $addElement_tdParams

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$addElement_tdParams = array( )

Keys are fieldnames and values are td-parameters to add in addElement(), please use $addElement_tdCSSClass for CSS-classes;

Definition at line 181 of file DatabaseRecordList.php.

◆ $allFields

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$allFields = 0

Indicates if all available fields for a user should be selected or not.

Definition at line 261 of file DatabaseRecordList.php.

◆ $allowedNewTables

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$allowedNewTables = array( )

Used to indicate which tables (values in the array) that can have a create-new-record link. If the array is empty, all tables are allowed.

Definition at line 67 of file DatabaseRecordList.php.

◆ $calcPerms

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$calcPerms = 0

Some permissions...

Definition at line 322 of file DatabaseRecordList.php.

◆ $CBnames

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$CBnames = array( )

Tracking names of elements (for clipboard use)

Definition at line 428 of file DatabaseRecordList.php.

◆ $clickMenuEnabled

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$clickMenuEnabled = true

If TRUE, clickmenus will be rendered

Definition at line 98 of file DatabaseRecordList.php.

◆ $clickTitleMode

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$clickTitleMode = ''

Mode for what happens when a user clicks the title of a record.

Definition at line 328 of file DatabaseRecordList.php.

◆ $clipObj

TYPO3 CMS Backend Clipboard Clipboard TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$clipObj

Clipboard object

Definition at line 422 of file DatabaseRecordList.php.

◆ $counter

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$counter = 0

Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard

Definition at line 374 of file DatabaseRecordList.php.

◆ $csvLines

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$csvLines = array( )
protected

Used to accumulate CSV lines for CSV export.

Definition at line 416 of file DatabaseRecordList.php.

◆ $csvOutput

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$csvOutput = false

If set, the listing is returned as CSV instead.

Definition at line 150 of file DatabaseRecordList.php.

◆ $currentLink

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$currentLink = array( )
protected

Current link: array with table names and uid

Definition at line 499 of file DatabaseRecordList.php.

◆ $currentTable

int [][] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$currentTable = array( )

Used for tracking next/prev uids

Definition at line 255 of file DatabaseRecordList.php.

◆ $deniedNewTables

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$deniedNewTables = array( )

Used to indicate which tables (values in the array) that cannot have a create-new-record link. If the array is empty, all tables are allowed.

Definition at line 74 of file DatabaseRecordList.php.

◆ $disableSingleTableView

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$disableSingleTableView = false

Disable single table view

Definition at line 116 of file DatabaseRecordList.php.

◆ $displayFields

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$displayFields

Containing which fields to display in extended mode

Definition at line 285 of file DatabaseRecordList.php.

◆ $dontShowClipControlPanels

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$dontShowClipControlPanels = false

If TRUE, will disable the rendering of clipboard + control panels.

Definition at line 80 of file DatabaseRecordList.php.

◆ $duplicateField

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$duplicateField

String, can contain the field name from a table which must have duplicate values marked.

Definition at line 404 of file DatabaseRecordList.php.

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

◆ $duplicateStack

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$duplicateStack = array( )

Used for tracking duplicate values of fields

Definition at line 193 of file DatabaseRecordList.php.

◆ $eCounter

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$eCounter = 0

Counting the elements no matter what...

Definition at line 386 of file DatabaseRecordList.php.

◆ $editable

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$editable = true
protected

If defined the records are editable

Definition at line 463 of file DatabaseRecordList.php.

◆ $fieldArray

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$fieldArray = array( )

◆ $firstElementNumber

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$firstElementNumber = 0

◆ $fixedL

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$fixedL = 30

Not used in this class - but maybe extension classes... Max length of strings

Definition at line 298 of file DatabaseRecordList.php.

◆ $hideTables

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$hideTables = ''

Tables which should not get listed

Definition at line 279 of file DatabaseRecordList.php.

◆ $hideTranslations

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$hideTranslations = ''

Tables which should not list their translations

Definition at line 144 of file DatabaseRecordList.php.

◆ $HTMLcode

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$HTMLcode = ''

String with accumulated HTML content

Definition at line 237 of file DatabaseRecordList.php.

◆ $iconFactory

IconFactory TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$iconFactory
protected

◆ $id

◆ $iLimit

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$iLimit = 0

◆ $itemsLimitPerTable

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$itemsLimitPerTable = 20

default Max items shown per table in "multi-table mode", may be overridden by tables.php

Definition at line 168 of file DatabaseRecordList.php.

◆ $itemsLimitSingleTable

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$itemsLimitSingleTable = 100

default Max items shown per table in "single-table mode", may be overridden by tables.php

Definition at line 221 of file DatabaseRecordList.php.

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

◆ $languageIconTitles

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$languageIconTitles = array( )

Contains sys language icons and titles

Definition at line 138 of file DatabaseRecordList.php.

◆ $languagesAllowedForUser

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$languagesAllowedForUser = array( )
protected

All languages that are allowed by the user

Definition at line 519 of file DatabaseRecordList.php.

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

◆ $listOnlyInSingleTableMode

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$listOnlyInSingleTableMode = false

If TRUE, records are listed only if a specific table is selected.

Definition at line 205 of file DatabaseRecordList.php.

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

◆ $MOD_MENU

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$MOD_MENU

Injected by RecordList

Definition at line 457 of file DatabaseRecordList.php.

◆ $modTSconfig

array [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$modTSconfig

Module configuration

Definition at line 231 of file DatabaseRecordList.php.

◆ $moduleData

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$moduleData = array( )
protected

◆ $noControlPanels

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$noControlPanels = false

If TRUE, will DISABLE all control panels in lists. (Takes precedence)

Definition at line 92 of file DatabaseRecordList.php.

◆ $oddColumnsCssClass

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$oddColumnsCssClass = ''

If set this is

CSS-classname for odd columns in addElement. Used with db_layout / pages section

Definition at line 291 of file DatabaseRecordList.php.

◆ $overridePageIdList

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$overridePageIdList = array( )
protected

Override the page ids taken into account by getPageIdConstraint()

Definition at line 488 of file DatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getOverridePageIdList(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\setOverridePageIdList().

◆ $overrideUrlParameters

mixed [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$overrideUrlParameters = array( )
protected

Override/add urlparameters in listUrl() method

Definition at line 493 of file DatabaseRecordList.php.

◆ $pageinfo

mixed [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$pageinfo

Definition at line 451 of file DatabaseRecordList.php.

◆ $pageOverlays

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$pageOverlays = array( )

Contains page translation languages

Definition at line 132 of file DatabaseRecordList.php.

◆ $pageRecord

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$pageRecord = array( )

Loaded with page record with version overlay if any.

Definition at line 362 of file DatabaseRecordList.php.

◆ $pageRow

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$pageRow = array( )

Set to the page record (see writeTop())

Definition at line 126 of file DatabaseRecordList.php.

◆ $perms_clause

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$perms_clause = ''

Page select permissions

Definition at line 304 of file DatabaseRecordList.php.

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

◆ $recPath_cache

mixed [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$recPath_cache = array( )

Cache for record path

Definition at line 156 of file DatabaseRecordList.php.

◆ $referenceCount

int [][] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$referenceCount = array( )
protected

[$tablename][$uid] = number of references to this record

Definition at line 434 of file DatabaseRecordList.php.

◆ $returnUrl

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$returnUrl = ''

Return URL

Definition at line 310 of file DatabaseRecordList.php.

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

◆ $script

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

Current script name

Definition at line 199 of file DatabaseRecordList.php.

◆ $searchLevels

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$searchLevels = 0

◆ $searchString

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$searchString = ''

◆ $selFieldList

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$selFieldList

select fields for the query which fetches the translations of the current record

Definition at line 447 of file DatabaseRecordList.php.

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

◆ $setFields

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$setFields = array( )

Fields to display for the current table

Definition at line 368 of file DatabaseRecordList.php.

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

◆ $showClipboard

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$showClipboard = false

If TRUE, will show the clipboard in the field list.

Definition at line 86 of file DatabaseRecordList.php.

◆ $showIcon

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$showIcon = 1

Definition at line 332 of file DatabaseRecordList.php.

◆ $showLimit

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$showLimit = 0

◆ $showOnlyTranslatedRecords

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$showOnlyTranslatedRecords = false
protected

Only used to render translated records, used in list module to show page translations

Definition at line 505 of file DatabaseRecordList.php.

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

◆ $sortField

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$sortField

◆ $sortRev

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$sortRev

Field, indicating to sort in reverse order.

Definition at line 398 of file DatabaseRecordList.php.

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

◆ $spaceIcon

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$spaceIcon

◆ $systemLanguagesOnPage

array TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$systemLanguagesOnPage
protected

All languages that are included in the site configuration for the current page. New records can only be created in those languages.

Definition at line 513 of file DatabaseRecordList.php.

◆ $table

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$table = ''

Tablename if single-table mode

Definition at line 316 of file DatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getOnClickForRow(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getTable(), 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\DatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkWrapTable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\listURL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeClip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeFieldList(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeSearchString(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\overlayEditLockPermissions(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\prepareQueryBuilder(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\setTotalItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showNewRecLink(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\start().

◆ $tableDisplayOrder

array [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$tableDisplayOrder = array( )
protected

Array with before/after setting for tables Structure: 'tableName' => [ 'before' => ['A', ...] 'after' => [] ]

Definition at line 482 of file DatabaseRecordList.php.

◆ $tableList

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$tableList = ''

Specify a list of tables which are the only ones allowed to be displayed.

Definition at line 410 of file DatabaseRecordList.php.

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

◆ $tablesCollapsed

int [][] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$tablesCollapsed = array( )

Array of collapsed / uncollapsed tables in multi table view

Definition at line 227 of file DatabaseRecordList.php.

◆ $tableTSconfigOverTCA

mixed [][] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$tableTSconfigOverTCA = array( )

TSconfig which overwrites TCA-Settings

Definition at line 356 of file DatabaseRecordList.php.

◆ $thisScript

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$thisScript = ''

Script URL

Definition at line 211 of file DatabaseRecordList.php.

◆ $thumbs

bool TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$thumbs = false

Thumbnails on records containing files (pictures)

Definition at line 249 of file DatabaseRecordList.php.

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

◆ $totalItems

string TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$totalItems = ''

Set to the total number of items for a table when selecting.

Definition at line 350 of file DatabaseRecordList.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getTable(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation().

◆ $totalRowCount

int TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$totalRowCount

Count of record rows in view

Definition at line 104 of file DatabaseRecordList.php.

◆ $translateTools

TranslationConfigurationProvider TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$translateTools

◆ $translations

string [] TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$translations

Translations of the current record

Definition at line 440 of file DatabaseRecordList.php.

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

◆ $uriBuilder

UriBuilder TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$uriBuilder
protected

Definition at line 471 of file DatabaseRecordList.php.