TYPO3\CMS\Backend\RecordList\AbstractRecordList Class Reference

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

Public Member Functions
	__construct ()
	addElement ($h, $icon, $data, $trParams='', $lMargin='', $altLine='')
	writeTop ()
	writeBottom ()
	fwd_rwd_nav ($table='')
	fwd_rwd_HTML ($type, $pointer, $table='')
	listURL ($altId='')
	CBfunctions ()
	initializeLanguages ()
	languageFlag ($sys_language_uid, $addAsAdditionalText=TRUE)

Public Attributes
	$iLimit = 10
	$leftMargin = 0
	$showIcon = 1
	$no_noWrap = 0
	$oddColumnsCssClass = ''
	$backPath = ''
	$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
	determineScriptUrl ()
	getThisScript ()
	getTranslateTools ()
	generateReferenceToolTip (array $references, $launchViewParameter='')

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

Author

Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

See also

typo3/db_list.php

typo3/sysext/filelist/mod1/index.php

Definition at line 32 of file AbstractRecordList.php.

Constructor & Destructor Documentation

__construct()

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

(

)

Constructor

Definition at line 154 of file AbstractRecordList.php.

References $GLOBALS, and TYPO3\CMS\Backend\RecordList\AbstractRecordList\getTranslateTools().

Member Function Documentation

addElement()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::addElement	(		$h,
			$icon,
			$data,
			$trParams = '',
			$lMargin = '',
			$altLine = ''
	)

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

integer	$h	Is an integer >=0 and denotes how tall a 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

$tdParams

Is insert in the

-tags. Must carry a ' ' as first character

Parameters

	integer	OBSOLETE - NOT USED ANYMORE. $lMargin is the leftMargin (integer)
string	$altLine	Is the HTML -tag for an alternative 'gfx/ol/line.gif'-icon (used in the top)

Returns

string HTML content for the table row

Todo:

Define visibility

Definition at line 192 of file AbstractRecordList.php.

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

CBfunctions()

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

(

)

Returning JavaScript for ClipBoard functionality.

Returns

string

Todo:

Define visibility

Definition at line 358 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 164 of file AbstractRecordList.php.

References $moduleName, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl().

Referenced by TYPO3\CMS\Backend\RecordList\ElementBrowserRecordList\__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
integer	$pointer	Pointer
string	$table	Table name

Returns

string private

Todo:

Define visibility

Definition at line 325 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\$iLimit, TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), and TYPO3\CMS\Backend\RecordList\AbstractRecordList\listURL().

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

Todo:

Define visibility

Definition at line 292 of file AbstractRecordList.php.

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

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

generateReferenceToolTip()

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

protected

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

Parameters

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

Returns

string

Definition at line 445 of file AbstractRecordList.php.

References $result, and TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs().

Referenced by TYPO3\CMS\Filelist\FileList\makeRef().

getThisScript()

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

protected

Returns

string

Definition at line 175 of file AbstractRecordList.php.

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

getTranslateTools()

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

protected

Gets an instance of TranslationConfigurationProvider

Returns

Definition at line 430 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

Todo:

Define visibility

Definition at line 397 of file AbstractRecordList.php.

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

Referenced by TYPO3\CMS\Backend\View\PageLayoutView\getSelectedBackendLayoutUid(), 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

integer	$sys_language_uid	Sys language uid
boolean	$addAsAdditionalText	If set to true, only the flag is returned

Returns

string Language icon

Todo:

Define visibility

Definition at line 411 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon().

Referenced by TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawHeader().

listURL()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::listURL

(

$altId = ''

)

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)

Returns

string URL

Todo:

Define visibility

Definition at line 348 of file AbstractRecordList.php.

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

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

writeBottom()

TYPO3\CMS\Backend\RecordList\AbstractRecordList::writeBottom

(

)

Finishes the list with the "stopper"-gif, adding the HTML code for that item to the internal ->HTMLcode string

Returns

void

Todo:

Define visibility

Deprecated:

since 6.2, will be removed 2 versions later - Function not needed anymore

Definition at line 281 of file AbstractRecordList.php.

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

writeTop()

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

(

)

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

Returns

void

Todo:

Define visibility

Definition at line 270 of file AbstractRecordList.php.

Member Data Documentation

$addElement_tdCssClass

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$addElement_tdCssClass = array()

Todo:

Define visibility

Definition at line 84 of file AbstractRecordList.php.

$addElement_tdParams

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$addElement_tdParams = array()

Todo:

Define visibility

Definition at line 78 of file AbstractRecordList.php.

$backPath

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

Todo:

Define visibility

Definition at line 66 of file AbstractRecordList.php.

$counter

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

Todo:

Define visibility

Definition at line 108 of file AbstractRecordList.php.

$eCounter

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

Todo:

Define visibility

Definition at line 125 of file AbstractRecordList.php.

$fieldArray

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$fieldArray = array()

Todo:

Define visibility

Definition at line 72 of file AbstractRecordList.php.

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

$firstElementNumber

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

Todo:

Define visibility

Definition at line 120 of file AbstractRecordList.php.

$fixedL

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

Todo:

Define visibility

Definition at line 91 of file AbstractRecordList.php.

$HTMLcode

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

Todo:

Define visibility

Definition at line 131 of file AbstractRecordList.php.

$iLimit

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

Todo:

Define visibility

Definition at line 39 of file AbstractRecordList.php.

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

$languageIconTitles

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$languageIconTitles = array()

Todo:

Define visibility

Definition at line 143 of file AbstractRecordList.php.

$leftMargin

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

Todo:

Define visibility

Definition at line 45 of file AbstractRecordList.php.

$no_noWrap

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

Todo:

Define visibility

Definition at line 55 of file AbstractRecordList.php.

$oddColumnsCssClass

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

Todo:

Define visibility

Definition at line 61 of file AbstractRecordList.php.

$pageOverlays

TYPO3\CMS\Backend\RecordList\AbstractRecordList::$pageOverlays = array()

Todo:

Define visibility

Definition at line 137 of file AbstractRecordList.php.

$setLMargin

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

Todo:

Define visibility

Definition at line 102 of file AbstractRecordList.php.

$showIcon

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

Todo:

Define visibility

Definition at line 50 of file AbstractRecordList.php.

$thisScript

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

Script URL

Definition at line 96 of file AbstractRecordList.php.

$totalItems

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

Todo:

Define visibility

Definition at line 114 of file AbstractRecordList.php.

$translateTools

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

Definition at line 149 of file AbstractRecordList.php.

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