t3lib_recordList Class Reference

Inheritance diagram for t3lib_recordList:

List of all members.

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)
Public Attributes
	$iLimit = 10
	$leftMargin = 0
	$showIcon = 1
	$no_noWrap = 0
	$oddColumnsTDParams = ''
	$oddColumnsCssClass = ''
	$backPath = ''
	$fieldArray = Array()
	$addElement_tdParams = array()
	$addElement_tdCssClass = array()
	$fixedL = 30
	$script = ''
	$thumbScript = 'thumbs.php'
	$setLMargin = 1
	$counter = 0
	$totalItems = ''
	$firstElementNumber = 0
	$eCounter = 0
	$HTMLcode = ''
	$pageOverlays = array()
	$languageIconTitles = array()
	$translateTools
Protected Member Functions
	getTranslateTools ()

---

Detailed Description

Definition at line 66 of file class.t3lib_recordlist.php.

---

Constructor & Destructor Documentation

t3lib_recordList::__construct

(

)

constructor for t3lib_recordList

Author:

Ingo Renner <ingo@typo3.org>

Reimplemented in localRecordList.

Definition at line 103 of file class.t3lib_recordlist.php.

References $GLOBALS, and getTranslateTools().

---

Member Function Documentation

t3lib_recordList::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

Definition at line 123 of file class.t3lib_recordlist.php.

Referenced by fwd_rwd_nav(), localRecordList\renderListNavigation(), and writeBottom().

t3lib_recordList::CBfunctions

(

)

Returning JavaScript for ClipBoard functionality.

Returns:

string

Definition at line 308 of file class.t3lib_recordlist.php.

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

Creates the button with link to either forward or reverse

Parameters:

string	Type: "fwd" or "rwd"
integer	Pointer
string	Table name

Returns:

string private

Definition at line 272 of file class.t3lib_recordlist.php.

References $content, t3lib_iconWorks\getSpriteIcon(), and listURL().

Referenced by fwd_rwd_nav().

t3lib_recordList::fwd_rwd_nav

(

$

table = ''

)

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

Parameters:

string

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 239 of file class.t3lib_recordlist.php.

References addElement(), and fwd_rwd_HTML().

Referenced by tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_sys_note(), tx_cms_layout\getTable_tt_board(), and tx_cms_layout\makeOrdinaryList().

t3lib_recordList::getTranslateTools

(

)

[protected]

Gets an instance of t3lib_transl8tools.

Returns:

t3lib_transl8tools

Definition at line 386 of file class.t3lib_recordlist.php.

References t3lib_div\makeInstance().

Referenced by __construct(), and initializeLanguages().

t3lib_recordList::initializeLanguages

(

)

Initializes page languages and icons

Returns:

void

Definition at line 346 of file class.t3lib_recordlist.php.

References $GLOBALS, $TCA, t3lib_BEfunc\deleteClause(), getTranslateTools(), and t3lib_BEfunc\versioningPlaceholderClause().

Referenced by tx_cms_layout\getTable_tt_content(), and recordList\start().

t3lib_recordList::languageFlag

(

$

sys_language_uid

)

Return the icon for the language

Parameters:

integer

Sys language uid

Returns:

string Language icon

Definition at line 371 of file class.t3lib_recordlist.php.

References t3lib_iconWorks\getSpriteIcon().

Referenced by tx_cms_layout\tt_content_drawHeader().

t3lib_recordList::listURL

(

$

altId = ''

)

Creates the URL to this script, including all relevant GPvars

Parameters:

string

Alternative id value. Enter blank string for the current id ($this->id)

Returns:

string URL

Definition at line 298 of file class.t3lib_recordlist.php.

Referenced by fwd_rwd_HTML().

t3lib_recordList::writeBottom

(

)

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

Returns:

void

Definition at line 220 of file class.t3lib_recordlist.php.

References addElement(), and t3lib_iconWorks\skinImg().

t3lib_recordList::writeTop

(

)

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

Returns:

void

Definition at line 212 of file class.t3lib_recordlist.php.

---

Member Data Documentation

t3lib_recordList::$addElement_tdCssClass = array()

Definition at line 78 of file class.t3lib_recordlist.php.

t3lib_recordList::$addElement_tdParams = array()

Definition at line 77 of file class.t3lib_recordlist.php.

t3lib_recordList::$backPath = ''

Definition at line 75 of file class.t3lib_recordlist.php.

t3lib_recordList::$counter = 0

Definition at line 86 of file class.t3lib_recordlist.php.

Referenced by tx_cms_layout\getTable_tt_content().

t3lib_recordList::$eCounter = 0

Reimplemented in recordList, and fileList.

Definition at line 91 of file class.t3lib_recordlist.php.

t3lib_recordList::$fieldArray = Array()

Definition at line 76 of file class.t3lib_recordlist.php.

t3lib_recordList::$firstElementNumber = 0

Reimplemented in recordList, and fileList.

Definition at line 90 of file class.t3lib_recordlist.php.

t3lib_recordList::$fixedL = 30

Reimplemented in fileList.

Definition at line 81 of file class.t3lib_recordlist.php.

t3lib_recordList::$HTMLcode = ''

Reimplemented in recordList, and fileList.

Definition at line 92 of file class.t3lib_recordlist.php.

t3lib_recordList::$iLimit = 10

Reimplemented in recordList, and fileList.

Definition at line 69 of file class.t3lib_recordlist.php.

t3lib_recordList::$languageIconTitles = array()

Definition at line 95 of file class.t3lib_recordlist.php.

t3lib_recordList::$leftMargin = 0

Definition at line 70 of file class.t3lib_recordlist.php.

t3lib_recordList::$no_noWrap = 0

Definition at line 72 of file class.t3lib_recordlist.php.

t3lib_recordList::$oddColumnsCssClass = ''

Definition at line 74 of file class.t3lib_recordlist.php.

t3lib_recordList::$oddColumnsTDParams = ''

Definition at line 73 of file class.t3lib_recordlist.php.

t3lib_recordList::$pageOverlays = array()

Definition at line 94 of file class.t3lib_recordlist.php.

t3lib_recordList::$script = ''

Reimplemented in recordList, and fileList.

Definition at line 82 of file class.t3lib_recordlist.php.

t3lib_recordList::$setLMargin = 1

Definition at line 84 of file class.t3lib_recordlist.php.

t3lib_recordList::$showIcon = 1

Definition at line 71 of file class.t3lib_recordlist.php.

t3lib_recordList::$thumbScript = 'thumbs.php'

Definition at line 83 of file class.t3lib_recordlist.php.

t3lib_recordList::$totalItems = ''

Reimplemented in recordList, and fileList.

Definition at line 87 of file class.t3lib_recordlist.php.

t3lib_recordList::$translateTools

Definition at line 96 of file class.t3lib_recordlist.php.

---

The documentation for this class was generated from the following file:

• t3lib/class.t3lib_recordlist.php