TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList Class Reference

Inheritance diagram for TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList:

Public Member Functions
	__construct ()
	getButtons ()
	getDocHeaderButtons (ModuleTemplate $moduleTemplate)
	renderListRow ($table, $row, $cc, $titleCol, $thumbsCol, $indent=0)
	renderListHeader ($table, $currentIdList)
	makeControl ($table, $row)
	makeClip ($table, $row)
	makeLocalizationPanel ($table, $row)
	fieldSelectBox ($table, $formFields=true)
	linkClipboardHeaderIcon ($string, $table, $cmd, $warning='', $title='')
	clipNumPane ()
	addSortLink ($code, $field, $table)
	recPath ($pid)
	showNewRecLink ($table)
	makeReturnUrl ()
	setCsvRow ($csvRow)
	outputCSV ($prefix)
	addActionToCellGroup (&$cells, $action, $actionKey)
	setIsEditable ($isEditable)
	isEditable ($table)
Public Member Functions inherited from TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList
	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
	$allowedNewTables = []
	$deniedNewTables = []
	$newWizards = false
	$dontShowClipControlPanels = false
	$showClipboard = false
	$noControlPanels = false
	$clickMenuEnabled = true
	$totalRowCount
	$spaceIcon
	$disableSingleTableView = false
	$pageRow = []
	$csvOutput = false
	$clipObj
	$CBnames = []
	$translations
	$selFieldList
	$pageinfo
	$MOD_MENU
Public Attributes inherited from TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList
	$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
	isRowListingConditionFulfilled ($table, $row)
	getReferenceCount ($tableName, $uid)
	getPointerForPage ($page)
	renderListNavigation ($renderPart='top')
	createReferenceHtml ($tableName, $uid)
	initCSV ()
	addHeaderRowToCSV ()
	addToCSV (array $row=[])
	isRecordCurrentBackendUser ($table, $row)
	overlayEditLockPermissions ($table, $row=[], $editPermission=true)
	editLockPermissions ()
	getDatabaseConnection ()
	getModule ()
	getDocumentTemplate ()
Protected Member Functions inherited from TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList
	getSearchFields ($tableName)
	getBackendUserAuthentication ()
	getDatabaseConnection ()
Protected Member Functions inherited from TYPO3\CMS\Backend\RecordList\AbstractRecordList
	determineScriptUrl ()
	getThisScript ()
	getTranslateTools ()
	generateReferenceToolTip ($references, $launchViewParameter='')
	getLanguageService ()
	getDatabaseConnection ()

Static Protected Member Functions
static	removeControlFieldsFromFieldRow (array $row=[])

Protected Attributes
	$csvLines = []
	$referenceCount = []
	$editable = true
	$iconFactory
Protected Attributes inherited from TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList
	$overrideUrlParameters = []
	$tableDisplayOrder = []
Protected Attributes inherited from TYPO3\CMS\Backend\RecordList\AbstractRecordList
	$id = 0
	$iconFactory

Detailed Description

Class for rendering of Web>List module

Definition at line 36 of file DatabaseRecordList.php.

Constructor & Destructor Documentation

__construct()

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

(

)

Constructor

Definition at line 204 of file DatabaseRecordList.php.

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

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 2211 of file DatabaseRecordList.php.

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

addHeaderRowToCSV()

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

protected

Add header line with field names as CSV line

Returns

void

Definition at line 2128 of file DatabaseRecordList.php.

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

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

addSortLink()

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 2043 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\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.

Returns

void

Definition at line 2140 of file DatabaseRecordList.php.

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

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

clipNumPane()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::clipNumPane

(

)

Returns TRUE if a numeric clipboard pad is selected/active

Returns

bool

Definition at line 2028 of file DatabaseRecordList.php.

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

createReferenceHtml()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::createReferenceHtml (   $tableName,   $uid  )

protected

Creates the HTML for a reference count for the record with the UID $uid in the table $tableName.

Parameters

string	$tableName
int	$uid

Returns

string HTML of reference a link, will be empty if there are no

Definition at line 1840 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$referenceCount, $uid, TYPO3\CMS\Backend\RecordList\AbstractRecordList\generateReferenceToolTip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDatabaseConnection(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

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

editLockPermissions()

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 2288 of file DatabaseRecordList.php.

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

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

fieldSelectBox()

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 1916 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\$content, $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$setFields, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL(), and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeFieldList().

getButtons()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getButtons

(

)

Create the panel of buttons for submitting the form or otherwise perform operations.

Returns

string[] All available buttons as an assoc. array

Definition at line 216 of file DatabaseRecordList.php.

References $params, TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\Utility\BackendUtility\cshItem(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\editLockPermissions(), TYPO3\CMS\Backend\Utility\BackendUtility\editOnClick(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocumentTemplate(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getModule(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\GeneralUtility\linkThisUrl(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_NEW, TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick().

getDatabaseConnection()

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

protected

Returns

DatabaseConnection

Definition at line 2296 of file DatabaseRecordList.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\createReferenceHtml(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getReferenceCount().

getDocHeaderButtons()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::getDocHeaderButtons

(

ModuleTemplate

$moduleTemplate

)

Create the panel of buttons for submitting the form or otherwise perform operations.

Parameters

ModuleTemplate

$moduleTemplate

Definition at line 349 of file DatabaseRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\$fieldArray, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$firstElementNumber, $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$itemsLimitSingleTable, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$listOnlyInSingleTableMode, $params, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$selFieldList, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$sortField, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$totalItems, TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\editLockPermissions(), TYPO3\CMS\Backend\Utility\BackendUtility\editOnClick(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDatabaseConnection(), TYPO3\CMS\Backend\Template\ModuleTemplate\getDocHeaderComponent(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getModule(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordRaw(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getTable(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\initCSV(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRowListingConditionFulfilled(), TYPO3\CMS\Core\Utility\GeneralUtility\linkThisUrl(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapTable(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeFieldList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeQueryArray(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\outputCSV(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_NEW, TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\setTotalItems(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick(), TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING, and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

getDocumentTemplate()

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

protected

Returns

DocumentTemplate

Definition at line 2312 of file DatabaseRecordList.php.

References $GLOBALS.

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

getModule()

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

protected

Returns

BaseScriptClass

Definition at line 2304 of file DatabaseRecordList.php.

References $GLOBALS.

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

getPointerForPage()

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 1276 of file DatabaseRecordList.php.

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

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

getReferenceCount()

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 1024 of file DatabaseRecordList.php.

References $uid, and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDatabaseConnection().

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

initCSV()

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

protected

Initializes internal csvLines array with the header of field names

Returns

void

Definition at line 2118 of file DatabaseRecordList.php.

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

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

isEditable()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::isEditable

(

$table

)

Check if the table is readonly or editable

Parameters

string

$table

Returns

bool

Definition at line 2251 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$editable, $GLOBALS, and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table.

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

isRecordCurrentBackendUser()

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 2233 of file DatabaseRecordList.php.

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

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

isRowListingConditionFulfilled()

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 overriden in extending classes.

Parameters

string	$table	Table name
	string[]	$row Record

Returns

bool True, if all conditions are fulfilled.

Definition at line 862 of file DatabaseRecordList.php.

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

linkClipboardHeaderIcon()

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 tag wrapped link.

Definition at line 1994 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\$cmd, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

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

makeClip()

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

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

Parameters

string	$table	The table
	mixed[]	$row The record for which to make the clipboard panel.

Exceptions

makeClip: Allows to change clip-icons of records in list-module This hook method gets passed the current $cells array as third parameter. This array contains values for the clipboard icons generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is depending on the order of those array entries.

Definition at line 1701 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$duplicateField, $GLOBALS, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$spaceIcon, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getModule(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\overlayEditLockPermissions(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_EDIT, TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

makeControl()

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

recStatInfoHooks: Allows to insert HTML before record icons on various places

makeControl: Allows to change control icons of records in list-module This hook method gets passed the current $cells array as third parameter. This array contains values for the icons/actions generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is depending on the order of those array entries.

Definition at line 1396 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$id, $params, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$spaceIcon, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addActionToCellGroup(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, TYPO3\CMS\Backend\Utility\BackendUtility\editOnClick(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getLinkToDataHandlerAction(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getModule(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getReferenceCount(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isEditable(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isRecordCurrentBackendUser(), 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\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Backend\Utility\BackendUtility\referenceCount(), TYPO3\CMS\Backend\Utility\BackendUtility\selectVersionsOfRecord(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showNewRecLink(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Core\Utility\GeneralUtility\slashJS(), TYPO3\CMS\Backend\Utility\BackendUtility\translationCount(), and TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick().

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

makeLocalizationPanel()

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

Creates the localization panel

Parameters

string	$table	The table
	mixed[]	$row The record for which to make the localization panel.

Returns

string[] Array with key 0/1 with content for column 1 and 2

Definition at line 1859 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\$translations, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getBackendUserAuthentication(), TYPO3\CMS\Backend\Utility\BackendUtility\getLinkToDataHandlerAction(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isEditable(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\languageFlag(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

makeReturnUrl()

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 2103 of file DatabaseRecordList.php.

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

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

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:

Returns

void EXITS php execution!

Definition at line 2188 of file DatabaseRecordList.php.

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

overlayEditLockPermissions()

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 2266 of file DatabaseRecordList.php.

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

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

recPath()

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 2071 of file DatabaseRecordList.php.

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

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

removeControlFieldsFromFieldRow()

static 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 2156 of file DatabaseRecordList.php.

renderListHeader()

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

Rendering the header row for a table

Parameters

string	$table	Table name
	int[]	$currentIdList Array of the currently displayed uids of the table

Exceptions

renderListHeaderActions: Allows to change the clipboard icons of the Web>List table headers Above each listed table in Web>List a header row is shown. This hook allows to modify the icons responsible for the clipboard functions (shown above the clipboard checkboxes when a clipboard other than "Normal" is selected), or other "Action" functions which perform operations on the listed records.

renderListHeader: Allows to change the contents of columns/cells of the Web>List table headers Above each listed table in Web>List a header row is shown. Containing the labels of all shown fields and additional icons to create new records for this table or perform special clipboard tasks like mark and copy all listed records to clipboard, etc.

Definition at line 1046 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$id, $params, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Backend\RecordList\AbstractRecordList\addElement(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addSortLink(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\clipNumPane(), TYPO3\CMS\Backend\Utility\BackendUtility\editOnClick(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Backend\Utility\BackendUtility\getItemLabel(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getModule(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\isEditable(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\linkClipboardHeaderIcon(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\overlayEditLockPermissions(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\showNewRecLink(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

renderListNavigation()

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

protected

Creates a page browser for tables with many records

Parameters

string

$renderPart

Distinguish between 'top' and 'bottom' part of the navigation (above or below the records)

Returns

string Navigation HTML

Definition at line 1287 of file DatabaseRecordList.php.

References TYPO3\CMS\Recordlist\RecordList\$content, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$iLimit, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$totalItems, TYPO3\CMS\Backend\RecordList\AbstractRecordList\addElement(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getPointerForPage(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\listURL(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

renderListRow()

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 private

See also

getTable()

Definition at line 880 of file DatabaseRecordList.php.

References $GLOBALS, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$id, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\$table, TYPO3\CMS\Backend\RecordList\AbstractRecordList\addElement(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addToCSV(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\createReferenceHtml(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getModule(), TYPO3\CMS\Backend\Utility\BackendUtility\getProcessedValueExtra(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordToolTip(), TYPO3\CMS\Backend\Utility\BackendUtility\isRecordLocked(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkUrlMail(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeClip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\recPath(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\thumbCode(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapClickMenuOnIcon().

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

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.

Returns

void

Definition at line 2176 of file DatabaseRecordList.php.

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

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

setIsEditable()

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::setIsEditable

(

$isEditable

)

Parameters

bool

$isEditable

Definition at line 2241 of file DatabaseRecordList.php.

showNewRecLink()

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

See also

::showNewRecLink

Definition at line 2086 of file DatabaseRecordList.php.

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

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

Member Data Documentation

$allowedNewTables

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$allowedNewTables = []

Definition at line 48 of file DatabaseRecordList.php.

$CBnames

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$CBnames = []

Definition at line 153 of file DatabaseRecordList.php.

$clickMenuEnabled

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

Definition at line 93 of file DatabaseRecordList.php.

$clipObj

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

Definition at line 146 of file DatabaseRecordList.php.

$csvLines

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$csvLines = []

protected

Definition at line 132 of file DatabaseRecordList.php.

$csvOutput

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

Definition at line 139 of file DatabaseRecordList.php.

$deniedNewTables

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$deniedNewTables = []

Definition at line 56 of file DatabaseRecordList.php.

$disableSingleTableView

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

Definition at line 114 of file DatabaseRecordList.php.

$dontShowClipControlPanels

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

Definition at line 72 of file DatabaseRecordList.php.

$editable

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

protected

Definition at line 194 of file DatabaseRecordList.php.

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

$iconFactory

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

protected

Definition at line 199 of file DatabaseRecordList.php.

$MOD_MENU

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$MOD_MENU

Definition at line 187 of file DatabaseRecordList.php.

$newWizards

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$newWizards = false

Definition at line 65 of file DatabaseRecordList.php.

$noControlPanels

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

Definition at line 86 of file DatabaseRecordList.php.

$pageinfo

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$pageinfo

Definition at line 180 of file DatabaseRecordList.php.

$pageRow

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$pageRow = []

Definition at line 125 of file DatabaseRecordList.php.

$referenceCount

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$referenceCount = []

protected

Definition at line 160 of file DatabaseRecordList.php.

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

$selFieldList

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

Definition at line 175 of file DatabaseRecordList.php.

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

$showClipboard

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

Definition at line 79 of file DatabaseRecordList.php.

$spaceIcon

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

Definition at line 107 of file DatabaseRecordList.php.

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

$totalRowCount

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

Definition at line 100 of file DatabaseRecordList.php.

$translations

TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList::$translations

Definition at line 167 of file DatabaseRecordList.php.

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