TYPO3 4.1.0: localRecordList Class Reference

localRecordList::writeTop ( $ row )

Writes the top of the full listing

Parameters:

array

Current page record

Returns:: void (Adds content to internal variable, $this->HTMLcode)

Definition at line 122 of file class.db_list_extra.inc.

References t3lib_extMgm::extRelPath(), t3lib_div::fixed_lgd_cs(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getRecordIconAltText(), and t3lib_extMgm::isLoaded().

localRecordList::getTable	(	$	table,
		$	id,
		$	rowlist
	)

Creates the listing of records from a single table

Parameters:

	string	Table name
	integer	Page id
	string	List of fields to show in the listing. Pseudo fields will be added including the record header.

Returns:: string HTML table with the listing for the record.

Definition at line 303 of file class.db_list_extra.inc.

References recordList::$id, recordList::$table, t3lib_BEfunc::cshItem(), t3lib_BEfunc::deleteClause(), t3lib_recordList::fwd_rwd_nav(), initCSV(), t3lib_div::inList(), t3lib_extMgm::isLoaded(), recordList::linkWrapTable(), t3lib_div::loadTCA(), recordList::makeFieldList(), recordList::makeQueryArray(), outputCSV(), renderListHeader(), renderListRow(), recordList::setTotalItems(), t3lib_iconWorks::skinImg(), t3lib_div::trimExplode(), and t3lib_BEfunc::versioningPlaceholderClause().

localRecordList::renderListRow	(	$	table,
		$	row,
		$	cc,
		$	titleCol,
		$	thumbsCol,
		$	indent = `0`
	)

Rendering a single row for the list

Parameters:

	string	Table name
	array	Current record
	integer	Counter, counting for each time an element is rendered (used for alternating colors)
	string	Table field (column) where header value is found
	string	Table field (column) where (possible) thumbnails can be found
	integer	Indent from left.

Returns:: string Table row for the element private

See also:: getTable()

Definition at line 563 of file class.db_list_extra.inc.

References recordList::$table, addToCSV(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getProcessedValueExtra(), t3lib_BEfunc::getRecordIconAltText(), t3lib_BEfunc::getRecordTitle(), recordList::linkUrlMail(), recordList::linkWrapItems(), makeClip(), makeControl(), makeLocalizationPanel(), makeRef(), recPath(), recordList::thumbCode(), and t3lib_BEfunc::workspaceOL().

Referenced by getTable().

localRecordList::renderListHeader	(	$	table,
		$	currentIdList
	)

Rendering the header row for a table

Parameters:

	string	Table name
	array	Array of the currectly displayed uids of the table

Returns:: string Header table row private

See also:: getTable()

Definition at line 648 of file class.db_list_extra.inc.

References recordList::$table, addSortLink(), clipNumPane(), t3lib_extMgm::extRelPath(), t3lib_BEfunc::getItemLabel(), t3lib_BEfunc::getModTSconfig(), linkClipboardHeaderIcon(), showNewRecLink(), and t3lib_iconWorks::skinImg().

Referenced by getTable().

localRecordList::makeControl	(	$	table,
		$	row
	)

Creates the control panel for a single record in the listing.

Parameters:

	string	The table
	array	The record for which to make the control panel.

Returns:: string HTML table with the control panel (unless disabled)

Definition at line 796 of file class.db_list_extra.inc.

References recordList::$table, t3lib_BEfunc::getRecord(), t3lib_extMgm::isLoaded(), t3lib_BEfunc::isRecordLocked(), t3lib_div::loadTCA(), t3lib_BEfunc::selectVersionsOfRecord(), and showNewRecLink().

Referenced by renderListRow().

localRecordList::makeClip	(	$	table,
		$	row
	)

Creates the clipboard panel for a single record in the listing.

Parameters:

	string	The table
	array	The record for which to make the clipboard panel.

Returns:: string HTML table with the clipboard panel (unless disabled)

Definition at line 986 of file class.db_list_extra.inc.

References recordList::$table.

Referenced by renderListRow().

localRecordList::makeRef	(	$	table,
		$	uid
	)

Make reference count

Parameters:

	string	Table name
	integer	UID of record

Returns:: string HTML-table

Definition at line 1057 of file class.db_list_extra.inc.

References recordList::$table.

Referenced by addToCSV(), and renderListRow().

localRecordList::makeLocalizationPanel	(	$	table,
		$	row
	)

Creates the localization panel

Parameters:

	string	The table
	array	The record for which to make the localization panel.

Returns:: array Array with key 0/1 with content for column 1 and 2

Definition at line 1086 of file class.db_list_extra.inc.

References recordList::$table, t3lib_recordList::languageFlag(), recordList::listURL(), and t3lib_div::makeInstance().

Referenced by renderListRow().

localRecordList::fieldSelectBox	(	$	table,
		$	formFields = `1`
	)

Create the selector box for selecting fields to display from a table:

Parameters:

	string	Table name
	boolean	If true, form-fields will be wrapped around the table.

Returns:: string HTML table with the selector box (name: displayFields['.$table.'][])

Definition at line 1134 of file class.db_list_extra.inc.

References recordList::$setFields, recordList::$table, t3lib_div::loadTCA(), and recordList::makeFieldList().

localRecordList::linkClipboardHeaderIcon	(	$	string,
		$	table,
		$	cmd,
		$	warning = `''`
	)

Creates a link around $string. The link contains an onclick action which submits the script with some clipboard action. Currently, this is used for setting elements / delete elements.

Parameters:

	string	The HTML content to link (image/text)
	string	Table name
	string	Clipboard command (eg. "setCB" or "delete")
	string	Warning text, if any ("delete" uses this for confirmation)

Returns:: string tag wrapped link.

Definition at line 1217 of file class.db_list_extra.inc.

Referenced by renderListHeader().

localRecordList::clipNumPane ( )

Returns true if a numeric clipboard pad is selected/active

Returns:: boolean

Definition at line 1228 of file class.db_list_extra.inc.

Referenced by renderListHeader().

localRecordList::addSortLink	(	$	code,
		$	field,
		$	table
	)

Creates a sort-by link on the input string ($code). It will automatically detect if sorting should be ascending or descending depending on $this->sortRev. Also some fields will not be possible to sort (including if single-table-view is disabled).

Parameters:

	string	The string to link (text)
	string	The fieldname represented by the title ($code)
	string	Table name

Returns:: string Linked $code variable

Definition at line 1242 of file class.db_list_extra.inc.

References recordList::listURL().

Referenced by renderListHeader().

localRecordList::recPath ( $ pid )

Returns the path for a certain pid The result is cached internally for the session, thus you can call this function as much as you like without performance problems.

Parameters:

integer

The page id for which to get the path

Returns:: string The path.

Definition at line 1267 of file class.db_list_extra.inc.

References t3lib_BEfunc::getRecordPath().

Referenced by addToCSV(), and renderListRow().

localRecordList::showNewRecLink ( $ table )

Returns true if a link for creating new records should be displayed for $table

Parameters:

string

Table name

Returns:: boolean

Definition at line 1280 of file class.db_list_extra.inc.

References recordList::$table.

Referenced by makeControl(), and renderListHeader().

localRecordList::makeReturnUrl ( )

Creates the "&returnUrl" parameter for links - this is used when the script links to other scripts and passes its own URL with the link so other scripts can return to the listing again. Uses REQUEST_URI as value.

Returns:: string

Definition at line 1290 of file class.db_list_extra.inc.

References t3lib_div::getIndpEnv().

localRecordList::initCSV ( )

Initializes internal csvLines array with the header of field names

Returns:: void

Definition at line 1315 of file class.db_list_extra.inc.

References setCsvRow().

Referenced by getTable().

localRecordList::addToCSV	(	$	row,
		$	table
	)

Adds the content of input array $row to the CSV list:

Parameters:

	array	Record array, from which the values of fields found in $this->fieldArray will be listed in the CSV output.
	string	Table name

Returns:: void

Definition at line 1338 of file class.db_list_extra.inc.

References recordList::$table, makeRef(), recPath(), and setCsvRow().

Referenced by renderListRow().

localRecordList::setCsvRow ( $ csvRow )

Adds input row of values to the internal csvLines array as a CSV formatted line

Parameters:

array

Array with values to be listed.

Returns:: void

Definition at line 1362 of file class.db_list_extra.inc.

References t3lib_div::csvValues().

Referenced by addToCSV(), and initCSV().

localRecordList::outputCSV ( $ prefix )

Compiles the internal csvLines array to a csv-string and outputs it to the browser. This function exits!

Parameters:

string

Filename prefix:

Returns:: void EXITS php execusion!

Definition at line 1373 of file class.db_list_extra.inc.

Referenced by getTable().


Public Member Functions
	writeTop ($row)
	getTable ($table, $id, $rowlist)
	renderListRow ($table, $row, $cc, $titleCol, $thumbsCol, $indent=0)
	renderListHeader ($table, $currentIdList)
	makeControl ($table, $row)
	makeClip ($table, $row)
	makeRef ($table, $uid)
	makeLocalizationPanel ($table, $row)
	fieldSelectBox ($table, $formFields=1)
	linkClipboardHeaderIcon ($string, $table, $cmd, $warning='')
	clipNumPane ()
	addSortLink ($code, $field, $table)
	recPath ($pid)
	showNewRecLink ($table)
	makeReturnUrl ()
	initCSV ()
	addToCSV ($row, $table)
	setCsvRow ($csvRow)
	outputCSV ($prefix)
Public Attributes
	$alternateBgColors = FALSE
	$allowedNewTables = array()
	$newWizards = FALSE
	$dontShowClipControlPanels = FALSE
	$showClipboard = FALSE
	$noControlPanels = FALSE
	$clickMenuEnabled = TRUE
	$pageRow = array()
	$csvLines = array()
	$csvOutput = FALSE
	$clipObj
	$CBnames = array()
	$duplicateStack = array()

Documentation TYPO3 par Ameos

localRecordList Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation