TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
AbstractRecordList Class Reference
Inheritance diagram for AbstractRecordList:
FileList AbstractDatabaseRecordList PageLayoutView DatabaseRecordList ElementBrowserRecordList ActionList

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 ()
 

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

Definition at line 36 of file AbstractRecordList.php.

Constructor & Destructor Documentation

Member Function Documentation

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$hIs 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$iconIs the + of the record. If not supplied the first 'join'-icon will be a 'line' instead
array$dataIs the dataarray, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in

-tags

Parameters
string$rowParamsIs 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$colTypeDefines 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 AbstractRecordList\$fieldArray, and $fields.

Referenced by FileList\formatDirList(), FileList\formatFileList(), AbstractRecordList\fwd_rwd_nav(), PageLayoutView\getTable_pages(), PageLayoutView\makeOrdinaryList(), PageLayoutView\pages_drawItem(), DatabaseRecordList\renderListHeader(), DatabaseRecordList\renderListNavigation(), and DatabaseRecordList\renderListRow().

CBfunctions ( )

Returning JavaScript for ClipBoard functionality.

Returns
string

Definition at line 387 of file AbstractRecordList.php.

determineScriptUrl ( )
protected

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

Definition at line 190 of file AbstractRecordList.php.

References GeneralUtility\_GP(), GeneralUtility\getIndpEnv(), and GeneralUtility\makeInstance().

Referenced by AbstractRecordList\__construct().

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

Creates the button with link to either forward or reverse

Parameters
string$typeType: "fwd" or "rwd
int$pointerPointer
string$tableTable name
Returns
string private

Definition at line 352 of file AbstractRecordList.php.

References AbstractRecordList\$iLimit, AbstractRecordList\listURL(), and Icon\SIZE_SMALL.

Referenced by AbstractRecordList\fwd_rwd_nav().

fwd_rwd_nav (   $table = '')

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

Parameters
string$tableTable 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 319 of file AbstractRecordList.php.

References AbstractRecordList\addElement(), and AbstractRecordList\fwd_rwd_HTML().

Referenced by PageLayoutView\getTable_pages(), and PageLayoutView\makeOrdinaryList().

generateReferenceToolTip (   $references,
  $launchViewParameter = '' 
)
protected

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

Parameters
int$referencesnumber of records from sys_refindex table
string$launchViewParameterJavaScript String, which will be passed as parameters to top.launchView
Returns
string

Definition at line 492 of file AbstractRecordList.php.

References AbstractRecordList\getLanguageService().

Referenced by DatabaseRecordList\createReferenceHtml(), and FileList\makeRef().

getThisScript ( )
protected
Returns
string

Definition at line 207 of file AbstractRecordList.php.

Referenced by AbstractRecordList\listURL().

getTranslateTools ( )
protected

Gets an instance of TranslationConfigurationProvider

Returns
TranslationConfigurationProvider

Definition at line 476 of file AbstractRecordList.php.

References AbstractRecordList\$translateTools, and GeneralUtility\makeInstance().

Referenced by AbstractRecordList\__construct(), and AbstractRecordList\initializeLanguages().

initializeLanguages ( )

Initializes page languages and icons

Returns
void

Definition at line 426 of file AbstractRecordList.php.

References AbstractRecordList\getTranslateTools(), and GeneralUtility\makeInstance().

Referenced by AbstractDatabaseRecordList\start().

languageFlag (   $sys_language_uid,
  $addAsAdditionalText = true 
)

Return the icon for the language

Parameters
int$sys_language_uidSys language uid
bool$addAsAdditionalTextIf set to true, only the flag is returned
Returns
string Language icon

Definition at line 456 of file AbstractRecordList.php.

References Icon\SIZE_SMALL.

Referenced by DatabaseRecordList\makeLocalizationPanel(), and PageLayoutView\tt_content_drawHeader().

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

Creates the URL to this script, including all relevant GPvars

Parameters
string$altIdAlternative id value. Enter blank string for the current id ($this->id)
string$tableTable name to display. Enter "-1" for the current table.
string$exclListComma separated list of fields NOT to include ("sortField", "sortRev" or "firstElementNumber")
Returns
string URL

Definition at line 377 of file AbstractRecordList.php.

References AbstractRecordList\$id, and AbstractRecordList\getThisScript().

Referenced by AbstractRecordList\fwd_rwd_HTML().

writeTop ( )

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

Returns
void

Definition at line 309 of file AbstractRecordList.php.

Member Data Documentation

$addElement_tdCssClass = []

Definition at line 93 of file AbstractRecordList.php.

$addElement_tdParams = []

Definition at line 86 of file AbstractRecordList.php.

$counter = 0

Definition at line 122 of file AbstractRecordList.php.

$eCounter = 0

Definition at line 141 of file AbstractRecordList.php.

$fieldArray = []
$firstElementNumber = 0

Definition at line 136 of file AbstractRecordList.php.

$fixedL = 30

Definition at line 101 of file AbstractRecordList.php.

$HTMLcode = ''

Definition at line 148 of file AbstractRecordList.php.

$iconFactory
protected

Definition at line 172 of file AbstractRecordList.php.

$id = 0
protected

Definition at line 41 of file AbstractRecordList.php.

Referenced by AbstractRecordList\listURL().

$iLimit = 10

Definition at line 48 of file AbstractRecordList.php.

Referenced by AbstractRecordList\fwd_rwd_HTML().

$languageIconTitles = []

Definition at line 162 of file AbstractRecordList.php.

$leftMargin = 0

Definition at line 55 of file AbstractRecordList.php.

$no_noWrap = 0

Definition at line 65 of file AbstractRecordList.php.

$oddColumnsCssClass = ''

Definition at line 72 of file AbstractRecordList.php.

$pageOverlays = []

Definition at line 155 of file AbstractRecordList.php.

$setLMargin = 1

Definition at line 115 of file AbstractRecordList.php.

$showIcon = 1

Definition at line 60 of file AbstractRecordList.php.

$thisScript = ''

Definition at line 108 of file AbstractRecordList.php.

$totalItems = ''

Definition at line 129 of file AbstractRecordList.php.

$translateTools

Definition at line 167 of file AbstractRecordList.php.

Referenced by AbstractRecordList\getTranslateTools().