Documentation TYPO3 par Ameos

recordList Class Reference

Inheritance diagram for recordList:

Inheritance graph
[legend]
Collaboration diagram for recordList:

Collaboration graph
[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 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 t3lib_BEfunc::cshItem().

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 $id, $perms_clause, and 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 $table, t3lib_div::fixed_lgd_cs(), t3lib_BEfunc::getRecord(), and t3lib_BEfunc::getRecordTitle().

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 $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 $table, and t3lib_div::inList().

Referenced by requestUri().

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, and t3lib_div::loadTCA().

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

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 $table, makeFieldList(), and makeSearchString().

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::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 $table, and t3lib_div::loadTCA().

Referenced by makeQueryArray().

recordList::requestUri  ) 
 

Returns "requestUri" - which is basically listURL

Returns:
string Content of ->listURL()

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

References listURL().

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.

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.

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

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 t3lib_BEfunc::deleteClause(), t3lib_iconWorks::getIconImage(), t3lib_extMgm::isLoaded(), and t3lib_div::loadTCA().

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 $id, $showLimit, $table, t3lib_div::_GP(), getTreeObject(), t3lib_recordList::initializeLanguages(), and t3lib_div::intInRange().

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 $table, and t3lib_BEfunc::thumbCode().

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


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


Généré par Les experts TYPO3 avec  doxygen 1.4.6