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)
 linkUrlMail ($code, $testString)
 listURL ($altId='', $table=-1, $exclList='')
 requestUri ()
 makeFieldList ($table, $dontCheckUser=0, $addDateFields=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 = ''
 $tableTSconfigOverTCA = array()
 $JScode = ''
 $HTMLcode = ''
 $iLimit = 0
 $eCounter = 0
 $totalItems = ''
 $recPath_cache = array()
 $setFields = array()
 $currentTable = array()
 $duplicateStack = array()

Detailed Description

Definition at line 86 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

Reimplemented in TBE_browser_recordList.

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

References $GLOBALS, $TCA, 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 279 of file class.db_list.inc.

References $content, $GLOBALS, and 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 738 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::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 624 of file class.db_list.inc.

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

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

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 557 of file class.db_list.inc.

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

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

Definition at line 540 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 651 of file class.db_list.inc.

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

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

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 756 of file class.db_list.inc.

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

Referenced by start().

recordList::makeFieldList ( $  table,
$  dontCheckUser = 0,
$  addDateFields = 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.
boolean If set, also adds crdate and tstamp fields (note: they will also be added if user is admin or dontCheckUser is set)
Returns:
array Array, where values are fieldnames to include in query

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

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

Referenced by localRecordList::fieldSelectBox(), 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 438 of file class.db_list.inc.

References $GLOBALS, $table, $TCA, 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::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.

Reimplemented in ux_localRecordList.

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

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

Referenced by makeQueryArray().

recordList::requestUri (  ) 

Returns "requestUri" - which is basically listURL

Returns:
string Content of ->listURL()

Definition at line 671 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 400 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 485 of file class.db_list.inc.

References $GLOBALS.

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 323 of file class.db_list.inc.

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

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 149 of file class.db_list.inc.

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

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 425 of file class.db_list.inc.

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

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

Member Data Documentation

recordList::$allFields = 0

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

recordList::$calcPerms = 0

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

recordList::$clickTitleMode = ''

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

recordList::$csvOutput = FALSE

Reimplemented in localRecordList.

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

recordList::$currentTable = array()

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

recordList::$displayFields

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

recordList::$duplicateField

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

recordList::$duplicateStack = array()

Reimplemented in localRecordList.

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

recordList::$eCounter = 0

Reimplemented from t3lib_recordList.

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

recordList::$firstElementNumber = 0

Reimplemented from t3lib_recordList.

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

recordList::$hideTables = ''

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

recordList::$HTMLcode = ''

Reimplemented from t3lib_recordList.

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

recordList::$id

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

Referenced by tx_cms_layout::getNonTranslatedTTcontentUids(), tx_cms_layout::getTable(), localRecordList::getTable(), tx_cms_layout::getTable_fe_users(), tx_cms_layout::getTable_pages(), tx_cms_layout::getTable_sys_note(), tx_cms_layout::getTable_tt_address(), tx_cms_layout::getTable_tt_board(), tx_cms_layout::getTable_tt_calender(), tx_cms_layout::getTable_tt_content(), tx_cms_layout::getTable_tt_guest(), tx_cms_layout::getTable_tt_links(), tx_cms_layout::getTable_tt_news(), tx_cms_layout::getTable_tt_products(), tx_cms_layout::getTableMenu(), getTreeObject(), tx_cms_layout::languageSelector(), tx_cms_layout::makeOrdinaryList(), tx_cms_layout::newContentElementOnClick(), and start().

recordList::$iLimit = 0

Reimplemented from t3lib_recordList.

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

recordList::$itemsLimitPerTable = 20

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

recordList::$itemsLimitSingleTable = 100

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

recordList::$JScode = ''

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

recordList::$listOnlyInSingleTableMode = FALSE

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

recordList::$localizationView = FALSE

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

recordList::$modSharedTSconfig = array()

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

recordList::$pageRecord = array()

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

recordList::$perms_clause = ''

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

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

recordList::$pidSelect = ''

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

recordList::$recPath_cache = array()

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

recordList::$returnUrl = ''

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

Referenced by localizationRedirect().

recordList::$script = 'db_list.php'

Reimplemented from t3lib_recordList.

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

recordList::$searchLevels = ''

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

recordList::$searchString = ''

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

recordList::$setFields = array()

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

Referenced by localRecordList::fieldSelectBox().

recordList::$showLimit = 0

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

Referenced by start().

recordList::$sortField

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

recordList::$sortRev

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

recordList::$table = ''

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

Referenced by localRecordList::addToCSV(), tx_cms_layout::dataFields(), localRecordList::fieldSelectBox(), tx_cms_layout::getIcon(), tx_cms_layout::getProcessedValue(), tx_cms_layout::getResult(), tx_cms_layout::getSpecConfForField(), tx_cms_layout::getTable(), localRecordList::getTable(), tx_cms_layout::headerFields(), tx_cms_layout::isDisabled(), tx_cms_layout::isRTEforField(), linkWrapItems(), TBE_browser_recordList::linkWrapItems(), linkWrapTable(), listURL(), TBE_browser_recordList::listURL(), localizationRedirect(), localRecordList::makeClip(), localRecordList::makeControl(), makeFieldList(), localRecordList::makeLocalizationPanel(), tx_cms_layout::makeOrdinaryList(), makeQueryArray(), localRecordList::makeRef(), ux_localRecordList::makeSearchString(), makeSearchString(), tx_cms_layout::numberOfRecords(), localRecordList::renderListHeader(), localRecordList::renderListRow(), localRecordList::showNewRecLink(), start(), thumbCode(), and tx_cms_layout::tt_board_drawItem().

recordList::$tableList = ''

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

recordList::$tableTSconfigOverTCA = array()

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

recordList::$thumbs = 0

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

recordList::$totalItems = ''

Reimplemented from t3lib_recordList.

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

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

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

The documentation for this class was generated from the following file:
Generated on Sat Nov 29 04:23:31 2008 for TYPO3 API by  doxygen 1.4.7