localRecordList Class Reference

Inheritance diagram for localRecordList:

Inheritance graph
[legend]
Collaboration diagram for localRecordList:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 getButtons ()
 getTable ($table, $id, $rowlist)
 renderListRow ($table, $row, $cc, $titleCol, $thumbsCol, $indent=0)
 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 ()
 initCSV ()
 addToCSV ($row, $table)
 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()
 $csvLines = array()
 $csvOutput = FALSE
 $clipObj
 $CBnames = array()
 $duplicateStack = array()

Detailed Description

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

Member Function Documentation

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

References recordList::listURL().

Referenced by renderListHeader().

localRecordList::addToCSV ( $  row,
$  table 
)

Adds the content of input array $row to the CSV list:

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

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

References $row, recordList::$table, makeRef(), recPath(), and setCsvRow().

Referenced by renderListRow().

localRecordList::clipNumPane (  ) 

Returns true if a numeric clipboard pad is selected/active

Returns:
boolean

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

Referenced by renderListHeader().

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

References $content, recordList::$setFields, recordList::$table, $TCA, t3lib_div::loadTCA(), and recordList::makeFieldList().

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

References $GLOBALS, t3lib_BEfunc::cshItem(), t3lib_extMgm::extRelPath(), t3lib_extMgm::isLoaded(), and t3lib_iconWorks::skinImg().

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

References $GLOBALS, recordList::$id, $row, recordList::$table, $TCA, $TYPO3_CONF_VARS, t3lib_BEfunc::cshItem(), t3lib_BEfunc::deleteClause(), t3lib_recordList::fwd_rwd_nav(), t3lib_div::getUserObj(), initCSV(), t3lib_div::inList(), t3lib_extMgm::isLoaded(), recordList::linkWrapTable(), t3lib_div::loadTCA(), recordList::makeFieldList(), recordList::makeQueryArray(), outputCSV(), renderListHeader(), renderListRow(), recordList::setTotalItems(), t3lib_iconWorks::skinImg(), t3lib_div::trimExplode(), t3lib_BEfunc::versioningPlaceholderClause(), and t3lib_BEfunc::workspaceOL().

localRecordList::initCSV (  ) 

Initializes internal csvLines array with the header of field names

Returns:
void

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

References setCsvRow().

Referenced by getTable().

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

References $GLOBALS.

Referenced by renderListHeader().

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

References $row, recordList::$table, $TCA, $TYPO3_CONF_VARS, and t3lib_div::getUserObj().

Referenced by renderListRow().

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 Skaarhoj <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 accesible by an index-key. The order of the icons is dependend on the order of those array entries.

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

References $GLOBALS, $row, $SOBE, recordList::$table, $TCA, $TYPO3_CONF_VARS, t3lib_div::callUserFunction(), t3lib_div::fixed_lgd_cs(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), t3lib_div::getUserObj(), t3lib_extMgm::isLoaded(), t3lib_div::loadTCA(), t3lib_BEfunc::selectVersionsOfRecord(), showNewRecLink(), t3lib_div::slashJS(), and t3lib_div::testInt().

Referenced by renderListRow().

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

References $GLOBALS, $row, recordList::$table, $TCA, t3lib_recordList::languageFlag(), recordList::listURL(), t3lib_div::makeInstance(), and nbsp.

Referenced by renderListRow().

localRecordList::makeRef ( $  table,
$  uid 
)

Make reference count

Parameters:
string Table name
integer UID of record
Returns:
string HTML-table

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

References $GLOBALS, $row, and recordList::$table.

Referenced by addToCSV(), and renderListRow().

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

References t3lib_div::getIndpEnv().

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

References exit.

Referenced by getTable().

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

References $pid, and t3lib_BEfunc::getRecordPath().

Referenced by addToCSV(), and renderListRow().

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

References recordList::$table, $TCA, $TYPO3_CONF_VARS, addSortLink(), clipNumPane(), t3lib_extMgm::extRelPath(), t3lib_BEfunc::getItemLabel(), t3lib_BEfunc::getModTSconfig(), t3lib_div::getUserObj(), linkClipboardHeaderIcon(), nbsp, showNewRecLink(), and t3lib_iconWorks::skinImg().

Referenced by getTable().

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

References $GLOBALS, $row, recordList::$table, addToCSV(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getProcessedValueExtra(), t3lib_BEfunc::getRecordIconAltText(), t3lib_BEfunc::getRecordTitle(), t3lib_BEfunc::isRecordLocked(), recordList::linkUrlMail(), recordList::linkWrapItems(), makeClip(), makeControl(), makeLocalizationPanel(), makeRef(), nbsp, recPath(), t3lib_iconWorks::skinImg(), and recordList::thumbCode().

Referenced by getTable().

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

References t3lib_div::csvValues().

Referenced by addToCSV(), and initCSV().

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

References recordList::$table.

Referenced by makeControl(), and renderListHeader().

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

localRecordList::$csvLines = array()

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

localRecordList::$csvOutput = FALSE

Reimplemented from recordList.

Definition at line 111 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 120 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::$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.

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