TYPO3\CMS\Backend\RecordList\AbstractRecordList Class Reference

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

Public Member Functions
	__construct ()
string	addElement ($h, $icon, $data, $rowParams='', $_='', $_2='', $colType='td')
	writeTop ()
array	fwd_rwd_nav ($table='')
string	fwd_rwd_HTML ($type, $pointer, $table='')
string	listURL ($altId='', $table='-1', $exclList='')
string	CBfunctions ()
	initializeLanguages ()
string	languageFlag ($sys_language_uid, $addAsAdditionalText=true)

Public Attributes
int	$iLimit = 10
int	$leftMargin = 0
int	$showIcon = 1
int	$no_noWrap = 0
string	$oddColumnsCssClass = ''
array	$fieldArray = array( )
array	$addElement_tdParams = array( )
array	$addElement_tdCssClass = array( )
int	$fixedL = 30
string	$thisScript = ''
int	$setLMargin = 1
int	$counter = 0
string	$totalItems = ''
int	$firstElementNumber = 0
int	$eCounter = 0
string	$HTMLcode = ''
array	$pageOverlays = array( )
array	$languageIconTitles = array( )
TranslationConfigurationProvider	$translateTools

Protected Member Functions
	determineScriptUrl ()
string	getThisScript ()
TranslationConfigurationProvider	getTranslateTools ()
string	generateReferenceToolTip ($references, $launchViewParameter='')
LanguageService	getLanguageService ()

Protected Attributes
int	$id = 0
IconFactory	$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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 35 of file AbstractRecordList.php.

Constructor & Destructor Documentation

__construct()

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

(

)

Constructor

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 177 of file AbstractRecordList.php.

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

Member Function Documentation

addElement()

string 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	$_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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 225 of file AbstractRecordList.php.

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

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

CBfunctions()

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

(

)

Returning JavaScript for ClipBoard functionality.

Returns

‪string

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 389 of file AbstractRecordList.php.

determineScriptUrl()

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

protected

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 192 of file AbstractRecordList.php.

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

fwd_rwd_HTML()

string 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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 352 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()

array 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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 319 of file AbstractRecordList.php.

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

generateReferenceToolTip()

string 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.TYPO3.InfoWindow.showItem

Returns

‪string

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 503 of file AbstractRecordList.php.

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

getLanguageService()

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

protected

Returns the language service

Returns

‪LanguageService

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 524 of file AbstractRecordList.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\RecordList\AbstractRecordList\generateReferenceToolTip(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\getSearchBox(), and TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkWrapItems().

getThisScript()

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

protected

Returns

‪string

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 206 of file AbstractRecordList.php.

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

getTranslateTools()

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

protected

Gets an instance of TranslationConfigurationProvider

Returns

‪TranslationConfigurationProvider

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 486 of file AbstractRecordList.php.

References TYPO3\CMS\Backend\RecordList\AbstractRecordList\$translateTools.

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 427 of file AbstractRecordList.php.

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

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

languageFlag()

string 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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 465 of file AbstractRecordList.php.

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

listURL()

string 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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Reimplemented in TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList.

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.

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 308 of file AbstractRecordList.php.

Member Data Documentation

$addElement_tdCssClass

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

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 92 of file AbstractRecordList.php.

$addElement_tdParams

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

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 85 of file AbstractRecordList.php.

$counter

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

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 121 of file AbstractRecordList.php.

$eCounter

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 140 of file AbstractRecordList.php.

$fieldArray

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

Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 78 of file AbstractRecordList.php.

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

$firstElementNumber

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

Internal (used in this class.)

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 135 of file AbstractRecordList.php.

$fixedL

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

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 100 of file AbstractRecordList.php.

$HTMLcode

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

String with accumulated HTML content

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 147 of file AbstractRecordList.php.

$iconFactory

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

protected

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 171 of file AbstractRecordList.php.

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

$id

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

protected

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 40 of file AbstractRecordList.php.

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

$iLimit

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

default Max items shown

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 47 of file AbstractRecordList.php.

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

$languageIconTitles

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

Contains sys language icons and titles

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 161 of file AbstractRecordList.php.

$leftMargin

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

OBSOLETE - NOT USED ANYMORE. leftMargin

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 54 of file AbstractRecordList.php.

$no_noWrap

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 64 of file AbstractRecordList.php.

$oddColumnsCssClass

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

If set this is

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 71 of file AbstractRecordList.php.

$pageOverlays

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

Contains page translation languages

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 154 of file AbstractRecordList.php.

$setLMargin

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

Set to zero, if you don't want a left-margin with addElement function

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 114 of file AbstractRecordList.php.

$showIcon

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 59 of file AbstractRecordList.php.

$thisScript

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

Script URL

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 107 of file AbstractRecordList.php.

$totalItems

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

This could be set to the total number of items. Used by the fwd_rew_navigation...

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 128 of file AbstractRecordList.php.

$translateTools

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

Deprecated:

‪since TYPO3 v9, will be removed in TYPO3 v10.0

Definition at line 166 of file AbstractRecordList.php.

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