TYPO3\CMS\Backend\RecordList\AbstractRecordList Class Reference

Inheritance diagram for TYPO3\CMS\Backend\RecordList\AbstractRecordList:

Public Member Functions
	__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
	$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
	determineScriptUrl ()
	getThisScript ()
	getTranslateTools ()
	generateReferenceToolTip ($references, $launchViewParameter='')
	getLanguageService ()
	getDatabaseConnection ()

Protected Attributes
	$id = 0
	$iconFactory

Detailed Description

Library with a single function addElement that returns table rows based on some input.

Base for class listing of database records and files in the modules Web>List and File>Filelist

See also

typo3/db_list.php

typo3/sysext/filelist/mod1/index.php

Definition at line 36 of file AbstractRecordList.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::__construct

(

)

Constructor

Definition at line 177 of file AbstractRecordList.php.

References $GLOBALS, TYPO3\CMS\Backend\RecordList\AbstractRecordList\determineScriptUrl(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getTranslateTools(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

addElement()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::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 halv 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 dataarray, 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	$_	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 225 of file AbstractRecordList.php.

References $a, and TYPO3\CMS\Backend\RecordList\AbstractRecordList\$fieldArray.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\fwd_rwd_nav(), TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Backend\View\PageLayoutView\makeOrdinaryList(), TYPO3\CMS\Backend\View\PageLayoutView\pages_drawItem(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation(), and TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListRow().

CBfunctions()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::CBfunctions

(

)

Returning JavaScript for ClipBoard functionality.

Returns

string

Definition at line 388 of file AbstractRecordList.php.

determineScriptUrl()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::determineScriptUrl ( )

protected

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

Definition at line 190 of file AbstractRecordList.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\__construct().

fwd_rwd_HTML()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::fwd_rwd_HTML	(		$type,
			$pointer,
			$table = ''
	)

Creates the button with link to either forward or reverse

Parameters

string	$type	Type: "fwd" or "rwd
int	$pointer	Pointer
string	$table	Table name

Returns

string private

Definition at line 353 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\$iLimit, TYPO3\CMS\Backend\RecordList\AbstractRecordList\listURL(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\fwd_rwd_nav().

fwd_rwd_nav()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::fwd_rwd_nav

(

$table = ''

)

Creates a forward/reverse button based on the status of ->eCounter, ->firstElementNumber, ->iLimit

Parameters

string

$table

Table name

Returns

array array([boolean], [HTML]) where [boolean] is 1 for reverse element, [HTML] is the table-row code for the element

Definition at line 320 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\addElement(), and TYPO3\CMS\Backend\RecordList\AbstractRecordList\fwd_rwd_HTML().

Referenced by TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Filelist\FileList\linkClipboardHeaderIcon(), and TYPO3\CMS\Backend\View\PageLayoutView\makeOrdinaryList().

generateReferenceToolTip()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::generateReferenceToolTip (   $references,   $launchViewParameter = ''  )

protected

Generates HTML code for a Reference tooltip out of sys_refindex records you hand over

Parameters

int	$references	number of records from sys_refindex table
string	$launchViewParameter	JavaScript String, which will be passed as parameters to top.launchView

Returns

string

Definition at line 477 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\getLanguageService().

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\createReferenceHtml(), and TYPO3\CMS\Filelist\FileList\makeRef().

getDatabaseConnection()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::getDatabaseConnection ( )

protected

Returns the database connection

Returns

DatabaseConnection

Definition at line 507 of file AbstractRecordList.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\initializeLanguages().

getLanguageService()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::getLanguageService ( )

protected

Returns the language service

Returns

LanguageService

Definition at line 497 of file AbstractRecordList.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\View\PageLayoutView\checkIfTranslationsExistInLanguage(), TYPO3\CMS\Backend\View\PageLayoutView\dataFields(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\fieldSelectBox(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\generateReferenceToolTip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getButtons(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getTable(), TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), TYPO3\CMS\Backend\View\PageLayoutView\getTableMenu(), TYPO3\CMS\Backend\View\PageLayoutView\headerFields(), TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed(), TYPO3\CMS\Backend\View\PageLayoutView\languageSelector(), TYPO3\CMS\Backend\View\PageLayoutView\linkEditContent(), TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapItems(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeClip(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\makeControl(), TYPO3\CMS\Backend\View\PageLayoutView\makeOrdinaryList(), TYPO3\CMS\Backend\View\PageLayoutView\newLanguageButton(), TYPO3\CMS\Backend\View\PageLayoutView\noEditIcon(), TYPO3\CMS\Backend\View\PageLayoutView\pages_drawItem(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListHeader(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\renderListNavigation(), TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawColHeader(), and TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawHeader().

getThisScript()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::getThisScript ( )

protected

Returns

string

Definition at line 207 of file AbstractRecordList.php.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\listURL().

getTranslateTools()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::getTranslateTools ( )

protected

Gets an instance of TranslationConfigurationProvider

Returns

TranslationConfigurationProvider

Definition at line 461 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\$translateTools, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\__construct(), and TYPO3\CMS\Backend\RecordList\AbstractRecordList\initializeLanguages().

initializeLanguages()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::initializeLanguages

(

)

Initializes page languages and icons

Returns

void

Definition at line 427 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\deleteClause(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getDatabaseConnection(), TYPO3\CMS\Backend\RecordList\AbstractRecordList\getTranslateTools(), and TYPO3\CMS\Backend\Utility\BackendUtility\versioningPlaceholderClause().

Referenced by TYPO3\CMS\Backend\View\PageLayoutView\getTable_pages(), and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\start().

languageFlag()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::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 441 of file AbstractRecordList.php.

References TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

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

listURL()

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

Creates the URL to this script, including all relevant GPvars

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 378 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\$id, and TYPO3\CMS\Backend\RecordList\AbstractRecordList\getThisScript().

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\fwd_rwd_HTML().

writeTop()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::writeTop

(

)

Dummy function, used to write the top of a table listing.

Returns

void

Definition at line 310 of file AbstractRecordList.php.

Member Data Documentation

$addElement_tdCssClass

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$addElement_tdCssClass = []

Definition at line 93 of file AbstractRecordList.php.

$addElement_tdParams

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$addElement_tdParams = []

Definition at line 86 of file AbstractRecordList.php.

$counter

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$counter = 0

Definition at line 122 of file AbstractRecordList.php.

$eCounter

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$eCounter = 0

Definition at line 141 of file AbstractRecordList.php.

$fieldArray

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$fieldArray = []

Definition at line 79 of file AbstractRecordList.php.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\addElement(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\addToCSV(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getSearchFields().

$firstElementNumber

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$firstElementNumber = 0

Definition at line 136 of file AbstractRecordList.php.

$fixedL

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$fixedL = 30

Definition at line 101 of file AbstractRecordList.php.

$HTMLcode

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$HTMLcode = ''

Definition at line 148 of file AbstractRecordList.php.

$iconFactory

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$iconFactory

protected

Definition at line 172 of file AbstractRecordList.php.

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

$id

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$id = 0

protected

Definition at line 41 of file AbstractRecordList.php.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\listURL().

$iLimit

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$iLimit = 10

Definition at line 48 of file AbstractRecordList.php.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\fwd_rwd_HTML().

$languageIconTitles

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$languageIconTitles = []

Definition at line 162 of file AbstractRecordList.php.

$leftMargin

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$leftMargin = 0

Definition at line 55 of file AbstractRecordList.php.

$no_noWrap

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$no_noWrap = 0

Definition at line 65 of file AbstractRecordList.php.

$oddColumnsCssClass

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$oddColumnsCssClass = ''

Definition at line 72 of file AbstractRecordList.php.

$pageOverlays

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$pageOverlays = []

Definition at line 155 of file AbstractRecordList.php.

$setLMargin

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$setLMargin = 1

Definition at line 115 of file AbstractRecordList.php.

$showIcon

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$showIcon = 1

Definition at line 60 of file AbstractRecordList.php.

$thisScript

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$thisScript = ''

Definition at line 108 of file AbstractRecordList.php.

$totalItems

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$totalItems = ''

Definition at line 129 of file AbstractRecordList.php.

$translateTools

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$translateTools

Definition at line 167 of file AbstractRecordList.php.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\getTranslateTools().