Inheritance diagram for AbstractDatabaseRecordList:

Public Member Functions
	start ($id, $table, $pointer, $search= '', $levels=0, $showLimit=0)

	generateList ()

	getTable ($tableName, $id, $fields= '')

	setDispFields ()

	thumbCode ($row, $table, $field)

	makeQueryArray ($table, $id, $addWhere= '', $fieldList= '*')

	setTotalItems ($queryParts)

	makeSearchString ($table, $currentPid=-1)

	linkWrapTable ($table, $code)

	linkWrapItems ($table, $uid, $code, $row)

	linkUrlMail ($code, $testString)

	listURL ($altId= '', $table= '-1', $exclList= '')

	requestUri ()

	makeFieldList ($table, $dontCheckUser=false, $addDateFields=false)

	localizationRedirect ($justLocalized)

	setOverrideUrlParameters (array $urlParameters)

	setTableDisplayOrder (array $orderInformation)

Public Member Functions inherited from AbstractRecordList
	__construct ()

	addElement ($h, $icon, $data, $rowParams= '', $_= '', $_2= '', $colType= 'td')

	writeTop ()

	fwd_rwd_nav ($table= '')

	fwd_rwd_HTML ($type, $pointer, $table= '')

	listURL ($altId= '')

	CBfunctions ()

	initializeLanguages ()

	languageFlag ($sys_language_uid, $addAsAdditionalText=true)

Public Attributes
	$tableList = ''

	$returnUrl = ''

	$thumbs = 0

	$itemsLimitPerTable = 20

	$itemsLimitSingleTable = 100

	$script = 'index.php'

	$allFields = 0

	$localizationView = false

	$csvOutput = false

	$sortField

	$sortRev

	$displayFields

	$duplicateField

	$id

	$table = ''

	$listOnlyInSingleTableMode = false

	$firstElementNumber = 0

	$searchString = ''

	$searchLevels = ''

	$showLimit = 0

	$pidSelect = ''

	$perms_clause = ''

	$calcPerms = 0

	$clickTitleMode = ''

	$modSharedTSconfig = array()

	$pageRecord = array()

	$hideTables = ''

	$hideTranslations = ''

	$tableTSconfigOverTCA = array()

	$tablesCollapsed = array()

	$JScode = ''

	$HTMLcode = ''

	$iLimit = 0

	$eCounter = 0

	$totalItems = ''

	$recPath_cache = array()

	$setFields = array()

	$currentTable = array()

	$duplicateStack = array()

	$modTSconfig

Public Attributes inherited from AbstractRecordList
	$iLimit = 10

	$leftMargin = 0

	$showIcon = 1

	$no_noWrap = 0

	$oddColumnsCssClass = ''

	$fieldArray = array()

	$addElement_tdParams = array()

	$addElement_tdCssClass = array()

	$fixedL = 30

	$thisScript = ''

	$setLMargin = 1

	$counter = 0

	$totalItems = ''

	$firstElementNumber = 0

	$eCounter = 0

	$HTMLcode = ''

	$pageOverlays = array()

	$languageIconTitles = array()

	$translateTools

Protected Member Functions
	getSearchFields ($tableName)

	getBackendUserAuthentication ()

	getDatabaseConnection ()

Protected Member Functions inherited from AbstractRecordList
	determineScriptUrl ()

	getThisScript ()

	getTranslateTools ()

	generateReferenceToolTip ($references, $launchViewParameter= '')

	getLanguageService ()

	getDatabaseConnection ()

Protected Attributes
	$overrideUrlParameters = array()

	$tableDisplayOrder = []

Protected Attributes inherited from AbstractRecordList
	$id = 0

	$iconFactory

Detailed Description

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

See Also

Definition at line 36 of file AbstractDatabaseRecordList.php.

Member Function Documentation

generateList ( )

Traverses the table(s) to be listed and renders the output code for each: The HTML is accumulated in $this->HTMLcode Finishes off with a stopper-gif

Returns: void

Definition at line 430 of file AbstractDatabaseRecordList.php.

References $GLOBALS, RecordList\$showLimit, BackendUtility\deleteClause(), AbstractDatabaseRecordList\generateList(), RecordList\getBackendUserAuthentication(), AbstractDatabaseRecordList\getDatabaseConnection(), BackendUtility\getRecordWSOL(), AbstractDatabaseRecordList\getTable(), GeneralUtility\inList(), AbstractDatabaseRecordList\makeFieldList(), GeneralUtility\makeInstance(), GeneralUtility\trimExplode(), and BackendUtility\versioningPlaceholderClause().

Referenced by AbstractDatabaseRecordList\generateList().

getBackendUserAuthentication ( )

protected

Returns: BackendUserAuthentication

Definition at line 1130 of file AbstractDatabaseRecordList.php.

getDatabaseConnection ( )

protected

Returns: DatabaseConnection

Definition at line 1138 of file AbstractDatabaseRecordList.php.

Referenced by AbstractDatabaseRecordList\generateList(), AbstractDatabaseRecordList\makeQueryArray(), AbstractDatabaseRecordList\makeSearchString(), AbstractDatabaseRecordList\setTotalItems(), and AbstractDatabaseRecordList\start().

getSearchFields ( $tableName )

protected

Fetches a list of fields to use in the Backend search for the given table.

Parameters

string $tableName

Returns: string[]

Definition at line 780 of file AbstractDatabaseRecordList.php.

References AbstractRecordList\$fieldArray, $GLOBALS, GeneralUtility\callUserFunction(), AbstractDatabaseRecordList\getSearchFields(), and GeneralUtility\trimExplode().

Referenced by AbstractDatabaseRecordList\getSearchFields(), and AbstractDatabaseRecordList\makeSearchString().

getTable	(	$tableName,
		$id,
		$fields = `''`
	)

To be implemented in extending classes.

Parameters

string	$tableName
int	$id
string	$fields	List of fields to show in the listing. Pseudo fields will be added including the record header.

Returns: string HTML code

Definition at line 528 of file AbstractDatabaseRecordList.php.

References AbstractDatabaseRecordList\getTable().

Referenced by AbstractDatabaseRecordList\generateList(), and AbstractDatabaseRecordList\getTable().

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 890 of file AbstractDatabaseRecordList.php.

Referenced by DatabaseRecordList\renderListRow().

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)

Definition at line 829 of file AbstractDatabaseRecordList.php.

References $lang, RecordList\$table, Permission\CONTENT_EDIT, BackendUtility\editOnClick(), GeneralUtility\fixed_lgd_cs(), RecordList\getBackendUserAuthentication(), RecordList\getLanguageService(), BackendUtility\getRecord(), BackendUtility\getRecordTitle(), AbstractDatabaseRecordList\linkWrapItems(), Permission\PAGE_EDIT, and BackendUtility\viewOnClick().

Referenced by AbstractDatabaseRecordList\linkWrapItems(), and DatabaseRecordList\renderListRow().

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 812 of file AbstractDatabaseRecordList.php.

References RecordList\$table, AbstractDatabaseRecordList\linkWrapTable(), and AbstractDatabaseRecordList\listURL().

Referenced by AbstractDatabaseRecordList\linkWrapTable().

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 915 of file AbstractDatabaseRecordList.php.

Referenced by DatabaseRecordList\getButtons(), DatabaseRecordList\getDocHeaderButtons(), AbstractDatabaseRecordList\linkWrapTable(), and DatabaseRecordList\renderListHeader().

localizationRedirect ( $justLocalized )

Redirects to FormEngine if a record is just localized.

Parameters

string $justLocalized String with table, orig uid and language separated by ":

Returns: void

Definition at line 1063 of file AbstractDatabaseRecordList.php.

Referenced by AbstractDatabaseRecordList\start().

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 976 of file AbstractDatabaseRecordList.php.

Referenced by AbstractDatabaseRecordList\generateList(), and AbstractDatabaseRecordList\makeQueryArray().

makeQueryArray	(	$table,
		$id,
		$addWhere = `''`,
		$fieldList = `'*'`
	)

Returns the SQL-query array to select the records from a table $table with pid = $id

Parameters

string	$table	Table name
int	$id	Page id (NOT USED! $this->pidSelect is used instead)
string	$addWhere	Additional part for where clause
string	$fieldList	Field list to select, * for all (for "SELECT [fieldlist] FROM ...")

Returns: string[] Returns query array

Definition at line 636 of file AbstractDatabaseRecordList.php.

References $GLOBALS, RecordList\$id, RecordList\$table, BackendUtility\deleteClause(), AbstractDatabaseRecordList\getDatabaseConnection(), GeneralUtility\getUserObj(), AbstractDatabaseRecordList\makeFieldList(), AbstractDatabaseRecordList\makeQueryArray(), AbstractDatabaseRecordList\makeSearchString(), GeneralUtility\trimExplode(), and BackendUtility\versioningPlaceholderClause().

Referenced by PageLayoutView\getContentRecordsPerColumn(), PageLayoutView\makeOrdinaryList(), and AbstractDatabaseRecordList\makeQueryArray().

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 709 of file AbstractDatabaseRecordList.php.

References $GLOBALS, RecordList\$table, MathUtility\canBeInterpretedAsInteger(), elseif, AbstractDatabaseRecordList\getDatabaseConnection(), AbstractDatabaseRecordList\getSearchFields(), GeneralUtility\inList(), and AbstractDatabaseRecordList\makeSearchString().

Referenced by AbstractDatabaseRecordList\makeQueryArray(), and AbstractDatabaseRecordList\makeSearchString().

requestUri ( )

Returns "requestUri" - which is basically listURL

Returns: string Content of ->listURL()

Definition at line 963 of file AbstractDatabaseRecordList.php.

setDispFields ( )

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

Returns: void

Definition at line 598 of file AbstractDatabaseRecordList.php.

References RecordList\getBackendUserAuthentication(), and AbstractDatabaseRecordList\setDispFields().

Referenced by AbstractDatabaseRecordList\setDispFields().

setOverrideUrlParameters ( array $urlParameters )

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

Parameters

string[] $urlParameters

Returns: void

Definition at line 1089 of file AbstractDatabaseRecordList.php.

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

\UnexpectedValueException

Definition at line 1106 of file AbstractDatabaseRecordList.php.

setTotalItems ( $queryParts )

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

Parameters

string[] $queryParts Query array

Returns: void

See Also: makeQueryArray()

Definition at line 696 of file AbstractDatabaseRecordList.php.

References AbstractDatabaseRecordList\getDatabaseConnection(), and AbstractDatabaseRecordList\setTotalItems().

Referenced by PageLayoutView\makeOrdinaryList(), and AbstractDatabaseRecordList\setTotalItems().

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.