recordList Class Reference

Inheritance diagram for recordList:

[legend]Collaboration diagram for recordList:

[legend]List of all members.

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)
	listURL ($altId=', $table=-1, $exclList=')
	requestUri ()
	makeFieldList ($table, $dontCheckUser=0)
	getTreeObject ($id, $depth, $perms_clause)
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()
	$JScode = ''
	$HTMLcode = ''
	$iLimit = 0
	$eCounter = 0
	$totalItems = ''
	$recPath_cache = array()
	$setFields = array()
	$currentTable = array()
	$duplicateStack = array()

---

Detailed Description

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

---

Member Function Documentation

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 195 of file class.db_list.inc. References $TCA, 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 242 of file class.db_list.inc. References $content, $parts, colspan, t3lib_BEfunc::cshItem(), input, select, selected, table, td, and value.

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 648 of file class.db_list.inc. References t3lib_div::makeInstance(). Referenced by tx_cms_layout::getTable_sys_note(), and start().

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 515 of file class.db_list.inc. References $GLOBALS, $LANG, $TCA, a, t3lib_div::fixed_lgd_cs(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), onclick, pages, and table. Referenced by localRecordList::renderListRow().

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 498 of file class.db_list.inc. References a, and table. Referenced by localRecordList::getTable().

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 578 of file class.db_list.inc. References t3lib_div::inList(), and table. Referenced by localRecordList::addSortLink().

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 608 of file class.db_list.inc. References $table, $TCA, t3lib_div::loadTCA(), and table. Referenced by localRecordList::fieldSelectBox(), and generateList().

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 401 of file class.db_list.inc. References $GLOBALS, $table, $TCA, pages, table, and WHERE. Referenced by localRecordList::getTable(), and tx_cms_layout::getTable_tt_content().

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 459 of file class.db_list.inc. References $TCA, input, t3lib_div::loadTCA(), and table.

recordList::requestUri (   )

Returns "requestUri" - which is basically listURL Returns: string Content of ->listURL() Definition at line 597 of file class.db_list.inc.

recordList::setDispFields (   )

Setting the field names to display in extended list. Sets the internal variable $this->setFields Returns: void Definition at line 363 of file class.db_list.inc. References $GLOBALS.

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 443 of file class.db_list.inc. References $GLOBALS, $result, and WHERE. Referenced by localRecordList::getTable().

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 286 of file class.db_list.inc. References $GLOBALS, $result, $TCA, colspan, t3lib_BEfunc::deleteClause(), t3lib_iconWorks::getIconImage(), t3lib_extMgm::isLoaded(), t3lib_div::loadTCA(), table, and td.

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 144 of file class.db_list.inc. References $GLOBALS, $table, $TCA, t3lib_div::_GP(), getTreeObject(), t3lib_recordList::initializeLanguages(), t3lib_div::intInRange(), and table.

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 388 of file class.db_list.inc. References field, table, and t3lib_BEfunc::thumbCode().

---

Member Data Documentation

recordList::$allFields = 0

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

recordList::$calcPerms = 0

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

recordList::$clickTitleMode = ''

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

recordList::$csvOutput = FALSE

Reimplemented in localRecordList. Definition at line 98 of file class.db_list.inc.

recordList::$currentTable = array()

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

recordList::$displayFields

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

recordList::$duplicateField

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

recordList::$duplicateStack = array()

Reimplemented in localRecordList. Definition at line 127 of file class.db_list.inc.

recordList::$eCounter = 0

Reimplemented from t3lib_recordList. Definition at line 122 of file class.db_list.inc.

recordList::$firstElementNumber = 0

Reimplemented from t3lib_recordList. Definition at line 108 of file class.db_list.inc.

recordList::$HTMLcode = ''

Reimplemented from t3lib_recordList. Definition at line 120 of file class.db_list.inc.

recordList::$id

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

recordList::$iLimit = 0

Reimplemented from t3lib_recordList. Definition at line 121 of file class.db_list.inc.

recordList::$itemsLimitPerTable = 20

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

recordList::$itemsLimitSingleTable = 100

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

recordList::$JScode = ''

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

recordList::$listOnlyInSingleTableMode = FALSE

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

recordList::$localizationView = FALSE

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

recordList::$modSharedTSconfig = array()

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

recordList::$perms_clause = ''

Definition at line 113 of file class.db_list.inc. Referenced by tx_cms_layout::getTable_sys_note().

recordList::$pidSelect = ''

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

recordList::$recPath_cache = array()

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

recordList::$returnUrl = ''

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

recordList::$script = 'db_list.php'

Reimplemented from t3lib_recordList. Reimplemented in TBE_browser_recordList. Definition at line 93 of file class.db_list.inc.

recordList::$searchLevels = ''

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

recordList::$searchString = ''

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

recordList::$setFields = array()

Definition at line 125 of file class.db_list.inc. Referenced by localRecordList::fieldSelectBox().

recordList::$showLimit = 0

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

recordList::$sortField

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

recordList::$sortRev

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

recordList::$table = ''

Definition at line 106 of file class.db_list.inc. Referenced by localRecordList::fieldSelectBox(), tx_cms_layout::getTable(), localRecordList::getTable(), TBE_browser_recordList::linkWrapItems(), localRecordList::makeClip(), localRecordList::makeControl(), localRecordList::renderListHeader(), and start().

recordList::$tableList = ''

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

recordList::$thumbs = 0

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

recordList::$totalItems = ''

Reimplemented from t3lib_recordList. Definition at line 123 of file class.db_list.inc.

recordList::$widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />'

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

---

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

• typo3/class.db_list.inc

---