TYPO3 4.1.0: recordList Class Reference

recordList::start	(	$	id,
		$	table,
		$	pointer,
		$	search = `""`,
		$	levels = `""`,
		$	showLimit = `0`
	)

Initializes the list generation

Parameters:

	integer	Page id for which the list is rendered. Must be >= 0
	string	Tablename - if extended mode where only one table is listed at a time.
	integer	Browsing pointer.
	string	Search word, if any
	integer	Number of levels to search down the page tree
	integer	Limit of records to be listed.

Returns:: void

Definition at line 148 of file class.db_list.inc.

References $id, $showLimit, $table, t3lib_div::_GP(), getTreeObject(), t3lib_recordList::initializeLanguages(), t3lib_div::intInRange(), and localizationRedirect().

recordList::generateList ( )

Traverses the table(s) to be listed and renders the output code for each: The HTML is accumulated in $this->HTMLcode Finishes off with a stopper-gif

Returns:: void

Definition at line 211 of file class.db_list.inc.

References t3lib_BEfunc::getRecordWSOL(), t3lib_div::inList(), t3lib_div::loadTCA(), and makeFieldList().

recordList::getSearchBox ( $ formFields = 1 )

Creates the search box

Parameters:

boolean

If true, the search box is wrapped in its own form-tags

Returns:: string HTML for the search box

Definition at line 275 of file class.db_list.inc.

References t3lib_BEfunc::cshItem().

recordList::showSysNotesForPage ( )

Creates the display of sys_notes for the page. Relies on the "sys_note" extension to be loaded.

Returns:: string HTML for the sys-notes (if any)

Definition at line 319 of file class.db_list.inc.

References t3lib_BEfunc::deleteClause(), t3lib_iconWorks::getIconImage(), t3lib_extMgm::isLoaded(), t3lib_div::loadTCA(), and t3lib_BEfunc::versioningPlaceholderClause().

recordList::setDispFields ( )

Setting the field names to display in extended list. Sets the internal variable $this->setFields

Returns:: void

Definition at line 396 of file class.db_list.inc.

recordList::thumbCode	(	$	row,
		$	table,
		$	field
	)

Create thumbnail code for record/field

Parameters:

	array	Record array
	string	Table (record is from)
	string	Field name for which thumbsnail are to be rendered.

Returns:: string HTML for thumbnails, if any.

Definition at line 421 of file class.db_list.inc.

References $table, and t3lib_BEfunc::thumbCode().

Referenced by tx_cms_layout::dataFields(), localRecordList::renderListRow(), and tx_cms_layout::tt_content_drawItem().

recordList::makeQueryArray	(	$	table,
		$	id,
		$	addWhere = `""`,
		$	fieldList = `'*'`
	)

Returns the SQL-query array to select the records from a table $table with pid = $id

Parameters:

	string	Table name
	integer	Page id (NOT USED! $this->pidSelect is used instead)
	string	Additional part for where clause
	string	Field list to select, * for all (for "SELECT [fieldlist] FROM ...")

Returns:: array Returns query array

Definition at line 434 of file class.db_list.inc.

References $table, t3lib_BEfunc::deleteClause(), makeFieldList(), makeSearchString(), and t3lib_BEfunc::versioningPlaceholderClause().

Referenced by tx_cms_layout::getNonTranslatedTTcontentUids(), localRecordList::getTable(), tx_cms_layout::getTable_tt_board(), tx_cms_layout::getTable_tt_content(), and tx_cms_layout::makeOrdinaryList().

recordList::setTotalItems ( $ queryParts )

Based on input query array (query for selecting count(*) from a table) it will select the number of records and set the value in $this->totalItems

Parameters:

array

Query array

Returns:: void

See also:: makeQueryArray()

Definition at line 481 of file class.db_list.inc.

Referenced by localRecordList::getTable(), tx_cms_layout::getTable_tt_board(), and tx_cms_layout::makeOrdinaryList().

recordList::makeSearchString ( $ table )

Creates part of query for searching after a word ($this->searchString) fields in input table

Parameters:

string

Table, in which the fields are being searched.

Returns:: string Returns part of WHERE-clause for searching, if applicable.

Definition at line 497 of file class.db_list.inc.

References $table, and t3lib_div::loadTCA().

Referenced by makeQueryArray().

recordList::linkWrapTable	(	$	table,
		$	code
	)

Returns the title (based on $code) of a table ($table) with the proper link around. For headers over tables. The link will cause the display of all extended mode or not for the table.

Parameters:

	string	Table name
	string	Table label

Returns:: string The linked table label

Reimplemented in TBE_browser_recordList.

Definition at line 536 of file class.db_list.inc.

References $table.

Referenced by localRecordList::getTable().

recordList::linkWrapItems	(	$	table,
		$	uid,
		$	code,
		$	row
	)

Returns the title (based on $code) of a record (from table $table) with the proper link around (that is for 'pages'-records a link to the level of that record...)

Parameters:

	string	Table name
	integer	Item uid
	string	Item title (not htmlspecialchars()'ed yet)
	array	Item row

Returns:: string The item title. Ready for HTML output (is htmlspecialchars()'ed)

Reimplemented in TBE_browser_recordList.

Definition at line 553 of file class.db_list.inc.

References $table, t3lib_div::fixed_lgd_cs(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), and linkUrlMail().

Referenced by localRecordList::renderListRow().

recordList::linkUrlMail	(	$	code,
		$	testString
	)

Wrapping input code in link to URL or email if $testString is either.

Parameters:

	string	code to wrap
	string	String which is tested for being a URL or email and which will be used for the link if so.

Returns:: string Link-Wrapped $code value, if $testString was URL or email.

Definition at line 617 of file class.db_list.inc.

References t3lib_div::inList(), and t3lib_div::validEmail().

Referenced by linkWrapItems(), and localRecordList::renderListRow().

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

Creates the URL to this script, including all relevant GPvars Fixed GPvars are id, table, imagemode, returlUrl, search_field, search_levels and showLimit The GPvars "sortField" and "sortRev" are also included UNLESS they are found in the $exclList variable.

Parameters:

	string	Alternative id value. Enter blank string for the current id ($this->id)
	string	Tablename to display. Enter "-1" for the current table.
	string	Commalist of fields NOT to include ("sortField" or "sortRev")

Returns:: string URL

Reimplemented in TBE_browser_recordList.

Definition at line 644 of file class.db_list.inc.

References $table, and t3lib_div::inList().

Referenced by localRecordList::addSortLink(), localizationRedirect(), localRecordList::makeLocalizationPanel(), and requestUri().

recordList::requestUri ( )

Returns "requestUri" - which is basically listURL

Returns:: string Content of ->listURL()

Definition at line 663 of file class.db_list.inc.

References listURL().

recordList::makeFieldList	(	$	table,
		$	dontCheckUser = `0`
	)

Makes the list of fields to select for a table

Parameters:

	string	Table name
	boolean	If set, users access to the field (non-exclude-fields) is NOT checked.

Returns:: array Array, where values are fieldnames to include in query

Definition at line 674 of file class.db_list.inc.

References $table, and t3lib_div::loadTCA().

Referenced by localRecordList::fieldSelectBox(), generateList(), localRecordList::getTable(), and makeQueryArray().

recordList::getTreeObject	(	$	id,
		$	depth,
		$	perms_clause
	)

Creates an instance of t3lib_pageTree which will select a page tree to $depth and return the object. In that object we will find the ids of the tree.

Parameters:

	integer	Page id.
	integer	Depth to go down.
	string	Select clause

Returns:: object t3lib_pageTree instance with created list of ids.

Definition at line 721 of file class.db_list.inc.

References $id, $perms_clause, and t3lib_div::makeInstance().

Referenced by tx_cms_layout::getTable_sys_note(), and start().

recordList::localizationRedirect ( $ justLocalized )

Redirects to TCEforms (alt_doc) if a record is just localized.

Parameters:

string

string with table, orig uid and language separated by ":"

Returns:: void

Definition at line 739 of file class.db_list.inc.

References $returnUrl, $table, t3lib_BEfunc::deleteClause(), listURL(), t3lib_div::locationHeaderUrl(), and t3lib_BEfunc::versioningPlaceholderClause().

Referenced by start().


Public Member Functions
	start ($id, $table, $pointer, $search="", $levels="", $showLimit=0)
	generateList ()
	getSearchBox ($formFields=1)
	showSysNotesForPage ()
	setDispFields ()
	thumbCode ($row, $table, $field)
	makeQueryArray ($table, $id, $addWhere="", $fieldList='*')
	setTotalItems ($queryParts)
	makeSearchString ($table)
	linkWrapTable ($table, $code)
	linkWrapItems ($table, $uid, $code, $row)
	linkUrlMail ($code, $testString)
	listURL ($altId='', $table=-1, $exclList='')
	requestUri ()
	makeFieldList ($table, $dontCheckUser=0)
	getTreeObject ($id, $depth, $perms_clause)
	localizationRedirect ($justLocalized)
Public Attributes
	$tableList = ''
	$returnUrl = ''
	$thumbs = 0
	$itemsLimitPerTable = 20
	$itemsLimitSingleTable = 100
	$widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />'
	$script = 'db_list.php'
	$allFields = 0
	$localizationView = FALSE
	$csvOutput = FALSE
	$sortField
	$sortRev
	$displayFields
	$duplicateField
	$id
	$table = ''
	$listOnlyInSingleTableMode = FALSE
	$firstElementNumber = 0
	$searchString = ''
	$searchLevels = ''
	$showLimit = 0
	$pidSelect = ''
	$perms_clause = ''
	$calcPerms = 0
	$clickTitleMode = ''
	$modSharedTSconfig = array()
	$pageRecord = array()
	$hideTables = ''
	$JScode = ''
	$HTMLcode = ''
	$iLimit = 0
	$eCounter = 0
	$totalItems = ''
	$recPath_cache = array()
	$setFields = array()
	$currentTable = array()
	$duplicateStack = array()

Documentation TYPO3 par Ameos

recordList Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation