Inheritance diagram for localRecordList:

Collaboration diagram for localRecordList:

Public Member Functions
	__construct ()
	getButtons ()
	getTable ($table, $id, $rowlist)
	renderListRow ($table, $row, $cc, $titleCol, $thumbsCol, $indent=0)
	setReferences ($table, $uid)
	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 ()
	setCsvRow ($csvRow)
	outputCSV ($prefix)
Public Attributes
	$alternateBgColors = FALSE
	$allowedNewTables = array()
	$deniedNewTables = array()
	$newWizards = FALSE
	$dontShowClipControlPanels = FALSE
	$showClipboard = FALSE
	$noControlPanels = FALSE
	$clickMenuEnabled = TRUE
	$totalRowCount
	$spaceIcon
	$pageRow = array()
	$csvOutput = FALSE
	$clipObj
	$CBnames = array()
	$duplicateStack = array()
	$references
	$translations
	$selFieldList
Protected Member Functions
	getReferenceCount ($tableName, $uid)
	renderListNavigation ($renderPart= 'top')
	createReferenceHtml ($tableName, $uid)
	initCSV ()
	addHeaderRowToCSV ()
	addToCSV (array $row=array(), $table= '')
Static Protected Member Functions
static	removeControlFieldsFromFieldRow (array $row=array())
Protected Attributes
	$csvLines = array()
	$referenceCount = array()

Detailed Description

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

Constructor & Destructor Documentation

localRecordList::__construct ( )

constructor for t3lib_recordList

Author:: Ingo Renner <ingo@typo3.org>

Reimplemented from t3lib_recordList.

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

Referenced by TBE_browser_recordList\TBE_browser_recordList().

Member Function Documentation

localRecordList::addHeaderRowToCSV ( ) [protected]

Add header line with field names as CSV line

Returns:: void

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

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 1705 of file class.db_list_extra.inc.

localRecordList::addToCSV	(	array $	row = `array()`,
		$	table = `''`
	)		`[protected]`

Adds selected columns of one table row as CSV line.

Parameters:

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

Deprecated:: since 4.4

Returns:: void

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

localRecordList::clipNumPane ( )

Returns true if a numeric clipboard pad is selected/active

Returns:: boolean

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

localRecordList::createReferenceHtml	(	$	tableName,
		$	uid
	)		`[protected]`

Creates the HTML for a reference count for the record with the UID $uid in the table $tableName.

Parameters:

string	$tableName	table name of the referenced record, must not be empty
integer	$uid	UID of the referenced record, must be > 0

Returns:: string HTML of reference a link, will be empty if there are no references to the corresponding record

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

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 1599 of file class.db_list_extra.inc.

localRecordList::getButtons ( )

Create the panel of buttons for submitting the form or otherwise perform operations.

Returns:: array all available buttons as an assoc. array

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

References $GLOBALS, t3lib_BEfunc\BEgetRootLine(), t3lib_BEfunc\cshItem(), t3lib_pageSelect\DOKTYPE_RECYCLER, t3lib_pageSelect\DOKTYPE_SYSFOLDER, t3lib_iconWorks\getSpriteIcon(), t3lib_div\trimExplode(), and t3lib_BEfunc\viewOnClick().

localRecordList::getReferenceCount	(	$	tableName,
		$	uid
	)		`[protected]`

Gets the number of records referencing the record with the UID $uid in the table $tableName.

Parameters:

string	$tableName	table name of the referenced record, must not be empty
integer	$uid	UID of the referenced record, must be > 0

Returns:: integer the number of references to record $uid in table $tableName, will be >= 0

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

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.

DB-List getTable

Date:: 2007-11-16 Malte Jansen <mail@maltejansen.de>

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

localRecordList::initCSV ( ) [protected]

Initializes internal csvLines array with the header of field names

Returns:: void

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

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 1680 of file class.db_list_extra.inc.

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 1382 of file class.db_list_extra.inc.

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)

recStatInfoHooks: Allows to insert HTML before record icons on various places

Date:: 2007-09-22 Kasper Skårhøj <kasper2007@typo3.com>

makeControl: Allows to change control icons of records in list-module

Date:: 2007-11-20 Bernhard Kraft <krafbt@kraftb.at> This hook method gets passed the current $cells array as third parameter. This array contains values for the icons/actions generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is dependend on the order of those array entries.

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

References $GLOBALS, $row, $SOBE, recordList\$table, $TCA, $TYPO3_CONF_VARS, t3lib_BEfunc\editOnClick(), t3lib_extMgm\extRelPath(), t3lib_BEfunc\getRecord(), t3lib_iconWorks\getSpriteIcon(), t3lib_extMgm\isLoaded(), t3lib_div\loadTCA(), t3lib_BEfunc\selectVersionsOfRecord(), showNewRecLink(), and t3lib_BEfunc\viewOnClick().

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 1546 of file class.db_list_extra.inc.

localRecordList::makeRef	(	$	table,
		$	uid
	)

Make reference count

Parameters:

string	Table name
integer	UID of record

Returns:: string HTML-table

Deprecated:: since 4.4, will be removed in TYPO3 4.6 - Use createReferenceHtml() instead

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

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 1763 of file class.db_list_extra.inc.

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 1854 of file class.db_list_extra.inc.

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 1730 of file class.db_list_extra.inc.

static localRecordList::removeControlFieldsFromFieldRow ( array $ row = array() ) [static, protected]

Remove control fields from row for CSV export

Parameters:

array fieldNames => fieldValues

Returns:: array Input array reduces by control fields

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

localRecordList::renderListHeader	(	$	table,
		$	currentIdList
	)

Rendering the header row for a table

Parameters:

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

Returns:: string Header table row private

See also:: getTable()

renderListHeaderActions: Allows to change the clipboard icons of the Web>List table headers

Date:: 2007-11-20 Bernhard Kraft <krafbt@kraftb.at> Above each listed table in Web>List a header row is shown. This hook allows to modify the icons responsible for the clipboard functions (shown above the clipboard checkboxes when a clipboard other than "Normal" is selected), or other "Action" functions which perform operations on the listed records.

renderListHeader: Allows to change the contents of columns/cells of the Web>List table headers

Date:: 2007-11-20 Bernhard Kraft <krafbt@kraftb.at> Above each listed table in Web>List a header row is shown. Containing the labels of all shown fields and additional icons to create new records for this table or perform special clipboard tasks like mark and copy all listed records to clipboard, etc.

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

localRecordList::renderListNavigation ( $ renderPart = 'top' ) [protected]

Creates a page browser for tables with many records

Parameters:

string Distinguish between 'top' and 'bottom' part of the navigation (above or below the records)

Returns:: string Navigation HTML

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

References $content, $GLOBALS, and t3lib_recordList\addElement().

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 638 of file class.db_list_extra.inc.

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 1843 of file class.db_list_extra.inc.

localRecordList::setReferences	(	$	table,
		$	uid
	)

Write sys_refindex entries for current record to $this->references

Parameters:

string	Table name
integer	Uid of current record

Returns:: void

Deprecated:: since 4.4, will be removed in TYPO3 4.6 - Use getReferenceCount instead

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

localRecordList::showNewRecLink ( $ table )

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

Parameters:

string Table name

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

See also:: SC_db_new::showNewRecLink

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

Referenced by makeControl().

Member Data Documentation

localRecordList::$allowedNewTables = array()

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

localRecordList::$alternateBgColors = FALSE

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

localRecordList::$CBnames = array()

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

localRecordList::$clickMenuEnabled = TRUE

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

localRecordList::$clipObj

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

localRecordList::$csvLines = array() [protected]

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

localRecordList::$csvOutput = FALSE

Reimplemented from recordList.

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

localRecordList::$deniedNewTables = array()

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

localRecordList::$dontShowClipControlPanels = FALSE

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

localRecordList::$duplicateStack = array()

Reimplemented from recordList.

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

localRecordList::$newWizards = FALSE

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

localRecordList::$noControlPanels = FALSE

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

localRecordList::$pageRow = array()

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

localRecordList::$referenceCount = array() [protected]

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

localRecordList::$references

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

localRecordList::$selFieldList

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

localRecordList::$showClipboard = FALSE

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

localRecordList::$spaceIcon

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

localRecordList::$totalRowCount

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

localRecordList::$translations

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

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

typo3/class.db_list_extra.inc

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation