TYPO3 Core

// Assemble key for loading the correct CSH file

$dsPointerFields = t3lib_div::trimExplode(',', $GLOBALS['TCA'][$table]['columns'][$field]['config']['ds_pointerField'], TRUE);

$PA['_cshKey'] = $table . '.' . $field;

foreach ($dsPointerFields as $key) {

$PA['_cshKey'] .= '.' . $row[$key];

}

t3lib_BEfunc::wrapInHelp($PA['_cshKey'], $key, $processedTitle) .

* @deprecated since TYPO3 4.5, this function will be removed in TYPO3 4.7. Use t3lib_BEfunc::wrapInHelp() instead.

t3lib_div::logDeprecatedFunction();

* @deprecated since TYPO3 4.5, this function will be removed in TYPO3 4.7. Use t3lib_BEfunc::wrapInHelp() instead.

t3lib_div::logDeprecatedFunction();

/**

* Key used to point to the right CSH resource

* In simple cases, is equal to $table

*

* @var string

*/

protected $mainKey;

$identifierParts = explode('.', $this->tfID);

// The table is the first item

$this->table = array_shift($identifierParts);

$this->mainKey = $this->table;

// The field is the second one

$this->field = array_shift($identifierParts);

// There may be extra parts for FlexForms

if (count($identifierParts) > 0) {

$flexFormField = array_pop($identifierParts);

$extraIdentifierInformation = $identifierParts;

// Assemble a different main key and switch field to use flexform field name

$this->mainKey .= '.' . $this->field;

foreach ($extraIdentifierInformation as $extraKey) {

$this->mainKey .= '.' . $extraKey;

}

$this->field = $flexFormField;

}

$this->content .= $TBE_TEMPLATE->startPage($LANG->getLL('title'));

if ($this->field == '*') {

// If ALL fields is supposed to be shown:

$this->content .= $this->render_Table($this->mainKey);

} elseif ($this->tfID) {

// ... otherwise show only single field:

$this->content .= $this->render_Single($this->mainKey, $this->field);

} elseif (is_array($this->ffID)) {

$this->content .= $this->render_SingleFlex();

} else {

// Render Table Of Contents if nothing else:

* @param string $key Full CSH key (may be different from table name)

* @param string $table CSH key / table name

* @return string HTML output

function render_Table($key, $table) {

t3lib_div::loadTCA($key);

$LANG->loadSingleTableDescription($key);

if (is_array($TCA_DESCR[$key]['columns']) && (!$this->limitAccess || $BE_USER->check('tables_select', $table))) {

foreach ($TCA_DESCR[$key]['columns'] as $field => $_) {

$fieldValue = isset($TCA[$key]) && strcmp($field, '') ? $TCA[$key]['columns'][$field] : array();

if (is_array($fieldValue) && (!$this->limitAccess || !$fieldValue['exclude'] || $BE_USER->check('non_exclude_fields', $table . ':' . $field))) {

$parts[0] = $this->printItem($key, '', 1); // Header

$parts[] = $this->printItem($key, $field, 1); // Field

$output .= implode('<br />', $parts);

if (!$this->renderALL) {

$tocLink = '<p class="c-nav"><a href="view_help.php">' . $LANG->getLL('goToToc', 1) . '</a></p>';

* @param string $key CSH key / table name

* @param string $field Sub key / field name

* @return string HTML output

function render_Single($key, $field) {

// Load the description field

$LANG->loadSingleTableDescription($key);

// Render single item

$output.= $this->printItem($key, $field);

<p class="c-nav"><a href="view_help.php?tfID=' . rawurlencode($key . '.*') . '">' . $LANG->getLL($getLLKey, 1) . '</a></p>

<p class="c-nav"><a href="view_help.php">' . $LANG->getLL('goToToc', 1) . '</a></p>';

* @deprecated since TYPO3 4.5, this function will be removed in TYPO3 4.7. Use render_Single() instead.

t3lib_div::logDeprecatedFunction();

* @param string $key CSH key / table name

* @param string $field Sub key / field name

* @param boolean $anchors If anchors is to be shown.

* @return string HTML content

function printItem($key, $field, $anchors = FALSE) {

$out = '';

t3lib_div::loadTCA($key);

if ($key && (!$field || is_array($TCA_DESCR[$key]['columns'][$field]))) {

$seeAlsoRes = $this->make_seeAlso($TCA_DESCR[$key]['columns'][$field]['seeAlso'], $anchors ? $key : '');

$out = '<a name="' . $key . '.' . $field . '"></a>' .

$this->headerLine($this->getTableFieldLabel($key, $field), 1) .

$this->prepareContent($TCA_DESCR[$key]['columns'][$field]['description']) .

($TCA_DESCR[$key]['columns'][$field]['details'] ? $this->headerLine($LANG->getLL('details').':').$this->prepareContent($TCA_DESCR[$key]['columns'][$field]['details']) : '') .

($TCA_DESCR[$key]['columns'][$field]['syntax'] ? $this->headerLine($LANG->getLL('syntax').':').$this->prepareContent($TCA_DESCR[$key]['columns'][$field]['syntax']) : '') .

($TCA_DESCR[$key]['columns'][$field]['image'] ? $this->printImage($TCA_DESCR[$key]['columns'][$field]['image'],$TCA_DESCR[$key]['columns'][$field]['image_descr']) : '') .

($TCA_DESCR[$key]['columns'][$field]['seeAlso'] && $seeAlsoRes ? $this->headerLine($LANG->getLL('seeAlso').':').'<p>'.$seeAlsoRes.'</p>' : '') .

($this->back ? '<br /><p><a href="' . htmlspecialchars('view_help.php?tfID=' . rawurlencode($this->back)) . '" class="typo3-goBack">' . htmlspecialchars($LANG->getLL('goBack')) . '</a></p>' : '') .

'<br />';

* @deprecated since TYPO3 4.5, this function will be removed in TYPO3 4.7. Use printItem() instead.

t3lib_div::logDeprecatedFunction();

* Returns labels for a given field in a given structure

* @param string $key CSH key / table name

* @param string $field Sub key / field name

* @return array Table and field labels in a numeric array

function getTableFieldNames($key, $field) {

$LANG->loadSingleTableDescription($key);

// Define the label for the key

$keyName = $key;

if (is_array($TCA_DESCR[$key]['columns']['']) && isset($TCA_DESCR[$key]['columns']['']['alttitle'])) {

// If there's an alternative title, use it

$keyName = $TCA_DESCR[$key]['columns']['']['alttitle'];

} elseif (isset($TCA[$key])) {

// Otherwise, if it's a table, use its title

$keyName = $TCA[$key]['ctrl']['title'];

} else {

// If no title was found, make sure to remove any "_MOD_"

$keyName = preg_replace('/^_MOD_/', '', $key);

}

// Define the label for the field

$fieldName = $field;

if (is_array($TCA_DESCR[$key]['columns'][$field]) && isset($TCA_DESCR[$key]['columns'][$field]['alttitle'])) {

// If there's an alternative title, use it

$fieldName = $TCA_DESCR[$key]['columns'][$field]['alttitle'];

} elseif (isset($TCA[$key])&&isset($TCA[$key]['columns'][$field])) {

// Otherwise, if it's a table, use its title

$fieldName = $TCA[$key]['columns'][$field]['label'];

}

return array($keyName, $fieldName);

* @param string $key CSH key / table name

* @param string $field Sub key / field name

* @param string $mergeToken Token to merge the two strings with

* @return string Labels joined with merge token

function getTableFieldLabel($key, $field = '', $mergeToken = ': ') {

$tableName = '';

$fieldName = '';

list($tableName, $fieldName) = $this->getTableFieldNames($key, $field);

$labelString = $LANG->sL($tableName) .

($field ? $mergeToken . rtrim(trim($LANG->sL($fieldName)), ':') : '');

return $labelString;