/***************************************************************
* Copyright notice
*
-* (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
+* (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project is
* Document for viewing the online help texts, also known as TCA_DESCR.
* See Inside TYPO3 for details.
*
- * $Id$
- * Revised for TYPO3 3.7 5/2004 by Kasper Skaarhoj
+ * Revised for TYPO3 3.7 5/2004 by Kasper Skårhøj
* XHTML-trans compliant
*
- * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
- */
-/**
- * [CLASS/FUNCTION INDEX of SCRIPT]
- *
- *
- *
- * 88: class SC_view_help
- * 111: function init()
- * 131: function main()
- * 160: function printContent()
- *
- * SECTION: Rendering main modes
- * 183: function render_TOC()
- * 292: function render_TOC_el($table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)
- * 324: function render_TOC_makeTocList($tocArray)
- * 363: function render_Table($table)
- * 420: function render_Single($table,$field)
- *
- * SECTION: Rendering CSH items
- * 463: function make_seeAlso($value,$anchorTable='')
- * 512: function printImage($images,$descr)
- * 547: function headerLine($str,$type=0)
- * 568: function prepareContent($str)
- * 583: function printItem($table,$field,$anchors=0)
- * 616: function getTableFieldNames($table,$field)
- * 639: function getTableFieldLabel($table,$field='',$mergeToken=': ')
- *
- * TOTAL FUNCTIONS: 15
- * (This index is automatically created/updated by the extension "extdeveval")
- *
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
*/
require('init.php');
require('template.php');
-$LANG->includeLLFile('EXT:lang/locallang_view_help.xml');
-require_once(PATH_t3lib.'class.t3lib_loadmodules.php');
-require_once(PATH_t3lib.'class.t3lib_parsehtml.php');
+$GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_view_help.xml');
+/**
+ * Extension of the parse_html class.
+ *
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @package TYPO3
+ * @subpackage core
+ */
class local_t3lib_parsehtml extends t3lib_parsehtml {
/**
* @access private
*/
function processContent($value,$dir,$conf) {
- $value = $this->pObj->substituteGlossaryWords($value);
+ $value = $this->pObj->substituteGlossaryWords_htmlcleaner_callback($value);
return $value;
}
-
}
/**
* Script Class for rendering the Context Sensitive Help documents, either the single display in the small pop-up window or the full-table view in the larger window.
*
- * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
* @package TYPO3
* @subpackage core
*/
var $allowedHTML = '<strong><em><b><i>';
// For these vars, see init()
- var $limitAccess; // If set access to fields and tables is checked. Should be done for true database tables.
+ var $limitAccess; // If set access to fields and tables is checked. Should be done for TRUE database tables.
var $table; // The "table" key
var $field; // The "field" key
+ /**
+ * Key used to point to the right CSH resource
+ * In simple cases, is equal to $table
+ *
+ * @var string
+ */
+ protected $mainKey;
// Internal, static: GPvar:
var $tfID; // Table/FIeld id.
+ var $ffID; // Flexform file/field information
var $back; // Back (previous tfID)
var $renderALL; // If set, then in TOC mode the FULL manual will be printed as well!
* @return void
*/
function init() {
- global $LANG, $TCA;
// Setting GPvars:
$this->tfID = t3lib_div::_GP('tfID');
+ // Sanitizes the tfID using whitelisting.
+ if (!preg_match('/^[a-zA-Z0-9_\-\.\*]*$/', $this->tfID)) {
+ $this->tfID = '';
+ }
+ if (!$this->tfID) {
+ if (($this->ffID = t3lib_div::_GP('ffID'))) {
+ $this->ffID = unserialize(base64_decode($this->ffID));
+ }
+ }
$this->back = t3lib_div::_GP('back');
$this->renderALL = t3lib_div::_GP('renderALL');
// Set internal table/field to the parts of "tfID" incoming var.
- list($this->table,$this->field) = explode('.',$this->tfID);
+ $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) {
+ // There's at least one extra part
+ $extraIdentifierInformation = array();
+ $extraIdentifierInformation[] = array_shift($identifierParts);
+ // Load the TCA details of the table
+ t3lib_div::loadTCA($this->table);
+ // If the ds_pointerField contains a comma, it means the choice of FlexForm DS
+ // is determined by 2 parameters. In this case we have an extra identifier part
+ if (strpos($GLOBALS['TCA'][$this->table]['columns'][$this->field]['config']['ds_pointerField'], ',') !== FALSE) {
+ $extraIdentifierInformation[] = array_shift($identifierParts);
+ }
+ // The remaining parts make up the FlexForm field name itself
+ // (reassembled with dots)
+ $flexFormField = implode('.', $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;
+ }
// limitAccess is checked if the $this->table really IS a table (and if the user is NOT a translator who should see all!)
$showAllToUser = t3lib_BEfunc::isModuleSetInTBE_MODULES('txllxmltranslateM1') && $GLOBALS['BE_USER']->check('modules','txllxmltranslateM1');
- $this->limitAccess = isset($TCA[$this->table]) ? !$showAllToUser : FALSE;
+ $this->limitAccess = isset($GLOBALS['TCA'][$this->table]) ? !$showAllToUser : FALSE;
}
/**
* @return void
*/
function main() {
- global $BE_USER,$LANG,$TCA_DESCR,$TCA,$TBE_TEMPLATE;
// Start HTML output accumulation:
- $TBE_TEMPLATE->docType = 'xhtml_trans';
- $TBE_TEMPLATE->divClass = 'typo3-view-help';
- $this->content.= $TBE_TEMPLATE->startPage($LANG->getLL('title'));
+ $GLOBALS['TBE_TEMPLATE']->divClass = 'typo3-view-help';
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->startPage($GLOBALS['LANG']->getLL('title'));
- if ($this->field=='*') { // If ALL fields is supposed to be shown:
+ if ($this->field == '*') {
+ // If ALL fields is supposed to be shown:
$this->createGlossaryIndex();
- $this->content.= $this->render_Table($this->table);
- } elseif ($this->tfID) { // ... otherwise show only single field:
+ $this->content .= $this->render_Table($this->mainKey);
+
+ } elseif ($this->tfID) {
+ // ... otherwise show only single field:
$this->createGlossaryIndex();
- $this->content.= $this->render_Single($this->table,$this->field);
- } else { // Render Table Of Contents if nothing else:
+ $this->content .= $this->render_Single($this->mainKey, $this->field);
+
+ } elseif (is_array($this->ffID)) {
+ $this->content .= $this->render_Single($this->mainKey, $this->field);
+
+ } else {
+ // Render Table Of Contents if nothing else:
$this->content.= $this->render_TOC();
}
// Print close-button:
-# $this->content.='<br /><form action=""><input type="submit" value="'.htmlspecialchars($LANG->getLL('close')).'" onclick="self.close(); return false;" /></form><br/>';
+# $this->content.='<br /><form action=""><input type="submit" value="'.htmlspecialchars($GLOBALS['LANG']->getLL('close')).'" onclick="self.close(); return false;" /></form><br/>';
// End page:
$this->content.= '<br/>';
- $this->content.= $TBE_TEMPLATE->endPage();
+ $this->content .= $GLOBALS['TBE_TEMPLATE']->endPage();
}
/**
* @return string HTML content
*/
function render_TOC() {
- global $TCA_DESCR,$TCA,$LANG,$BE_USER,$TBE_MODULES;
-
// Initialize:
- $CSHkeys = array_flip(array_keys($TCA_DESCR));
- $TCAkeys = array_keys($TCA);
+ $CSHkeys = array_flip(array_keys($GLOBALS['TCA_DESCR']));
+ $TCAkeys = array_keys($GLOBALS['TCA']);
$outputSections = array();
$tocArray = array();
// TYPO3 Core Features:
- $LANG->loadSingleTableDescription('xMOD_csh_corebe');
+ $GLOBALS['LANG']->loadSingleTableDescription('xMOD_csh_corebe');
$this->render_TOC_el('xMOD_csh_corebe', 'core', $outputSections, $tocArray, $CSHkeys);
// Backend Modules:
$loadModules = t3lib_div::makeInstance('t3lib_loadModules');
- $loadModules->load($TBE_MODULES);
+ $loadModules->load($GLOBALS['TBE_MODULES']);
foreach($loadModules->modules as $mainMod => $info) {
$cshKey = '_MOD_'.$mainMod;
if ($CSHkeys[$cshKey]) {
- $LANG->loadSingleTableDescription($cshKey);
+ $GLOBALS['LANG']->loadSingleTableDescription($cshKey);
$this->render_TOC_el($cshKey, 'modules', $outputSections, $tocArray, $CSHkeys);
}
foreach($info['sub'] as $subMod => $subInfo) {
$cshKey = '_MOD_'.$mainMod.'_'.$subMod;
if ($CSHkeys[$cshKey]) {
- $LANG->loadSingleTableDescription($cshKey);
+ $GLOBALS['LANG']->loadSingleTableDescription($cshKey);
$this->render_TOC_el($cshKey, 'modules', $outputSections, $tocArray, $CSHkeys);
}
}
// Database Tables:
foreach($TCAkeys as $table) {
// Load descriptions for table $table
- $LANG->loadSingleTableDescription($table);
- if (is_array($TCA_DESCR[$table]['columns']) && $BE_USER->check('tables_select',$table)) {
+ $GLOBALS['LANG']->loadSingleTableDescription($table);
+ if (is_array($GLOBALS['TCA_DESCR'][$table]['columns']) && $GLOBALS['BE_USER']->check('tables_select',$table)) {
$this->render_TOC_el($table, 'tables', $outputSections, $tocArray, $CSHkeys);
}
}
// Extensions
foreach($CSHkeys as $cshKey => $value) {
- if (t3lib_div::isFirstPartOfStr($cshKey, 'xEXT_') && !isset($TCA[$cshKey])) {
- $LANG->loadSingleTableDescription($cshKey);
+ if (t3lib_div::isFirstPartOfStr($cshKey, 'xEXT_') && !isset($GLOBALS['TCA'][$cshKey])) {
+ $GLOBALS['LANG']->loadSingleTableDescription($cshKey);
$this->render_TOC_el($cshKey, 'extensions', $outputSections, $tocArray, $CSHkeys);
}
}
// Glossary
foreach($CSHkeys as $cshKey => $value) {
- if (t3lib_div::isFirstPartOfStr($cshKey, 'xGLOSSARY_') && !isset($TCA[$cshKey])) {
- $LANG->loadSingleTableDescription($cshKey);
+ if (t3lib_div::isFirstPartOfStr($cshKey, 'xGLOSSARY_') && !isset($GLOBALS['TCA'][$cshKey])) {
+ $GLOBALS['LANG']->loadSingleTableDescription($cshKey);
$this->render_TOC_el($cshKey, 'glossary', $outputSections, $tocArray, $CSHkeys);
}
}
// Other:
foreach($CSHkeys as $cshKey => $value) {
- if (!t3lib_div::isFirstPartOfStr($cshKey, '_MOD_') && !isset($TCA[$cshKey])) {
- $LANG->loadSingleTableDescription($cshKey);
+ if (!t3lib_div::isFirstPartOfStr($cshKey, '_MOD_') && !isset($GLOBALS['TCA'][$cshKey])) {
+ $GLOBALS['LANG']->loadSingleTableDescription($cshKey);
$this->render_TOC_el($cshKey, 'other', $outputSections, $tocArray, $CSHkeys);
}
}
$output = '';
$output.= '
- <h1>'.$LANG->getLL('manual_title',1).'</h1>
- <p>'.t3lib_BEfunc::TYPO3_copyRightNotice().'</p>';
+ <h1>'.$GLOBALS['LANG']->getLL('manual_title',1).'</h1>';
$output.= '
- <h1>'.$LANG->getLL('introduction',1).'</h1>
- <p>'.$LANG->getLL('description',1).'</p>';
+ <h2>'.$GLOBALS['LANG']->getLL('introduction',1).'</h2>
+ <p>'.$GLOBALS['LANG']->getLL('description',1).'</p>';
$output.= '
- <h1>'.$LANG->getLL('TOC',1).'</h1>'.
+ <h2>'.$GLOBALS['LANG']->getLL('TOC',1).'</h2>'.
$this->render_TOC_makeTocList($tocArray);
if (!$this->renderALL) {
- $output.= '
+ $output.= '
<br/>
- <p class="c-nav"><a href="view_help.php?renderALL=1">'.$LANG->getLL('full_manual',1).'</a></p>';
+ <p class="c-nav"><a href="view_help.php?renderALL=1">'.$GLOBALS['LANG']->getLL('full_manual',1).'</a></p>';
}
if ($this->renderALL) {
$output.= '
- <h1>'.$LANG->getLL('full_manual_chapters',1).'</h1>'.
+ <h2>'.$GLOBALS['LANG']->getLL('full_manual_chapters',1).'</h2>'.
implode('
',$outputSections);
}
+ $output .= '<hr /><p class="manual-title">'.t3lib_BEfunc::TYPO3_copyRightNotice().'</p>';
+
return $output;
}
* @return void
*/
function render_TOC_el($table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys) {
- global $LANG;
-
if ($this->renderALL) { // Render full manual right here!
$outputSections[$table] = $this->render_Table($table);
$outputSections[$table] = '
<!-- New CSHkey/Table: '.$table.' -->
- <p class="c-nav"><a name="ANCHOR_'.$table.'" href="#">'.$LANG->getLL('to_top',1).'</a></p>
+ <p class="c-nav"><a name="ANCHOR_'.$table.'" href="#">'.$GLOBALS['LANG']->getLL('to_top',1).'</a></p>
<h2>'.$this->getTableFieldLabel($table).'</h2>
'.$outputSections[$table];
* @return string HTML bullet list for index.
*/
function render_TOC_makeTocList($tocArray) {
- global $LANG;
-
// The Various manual sections:
$keys = explode(',', 'core,modules,tables,extensions,glossary,other');
foreach($keys as $tocKey) {
if (is_array($tocArray[$tocKey])) {
$output.='
- <li>'.$LANG->getLL('TOC_'.$tocKey,1).'
+ <li>'.$GLOBALS['LANG']->getLL('TOC_'.$tocKey,1).'
<ul>
<li>'.implode('</li>
<li>',$tocArray[$tocKey]).'</li>
/**
* Render CSH for a full cshKey/table
*
- * @param string CSH key / table name
- * @return string HTML output
+ * @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($table) {
- global $BE_USER,$TCA_DESCR,$TCA,$LANG;
-
+ function render_Table($key, $table = NULL) {
$output = '';
+ // take default key if not explicitly specified
+ if ($table === NULL) {
+ $table = $key;
+ }
+
// Load table TCA
- t3lib_div::loadTCA($table);
+ t3lib_div::loadTCA($key);
// Load descriptions for table $table
- $LANG->loadSingleTableDescription($table);
+ $GLOBALS['LANG']->loadSingleTableDescription($key);
- if (is_array($TCA_DESCR[$table]['columns']) && (!$this->limitAccess || $BE_USER->check('tables_select',$table))) {
+ if (is_array($GLOBALS['TCA_DESCR'][$key]['columns']) && (!$this->limitAccess || $GLOBALS['BE_USER']->check('tables_select', $table))) {
// Initialize variables:
$parts = array();
$parts[0] = ''; // Reserved for header of table
// Traverse table columns as listed in TCA_DESCR
- reset($TCA_DESCR[$table]['columns']);
- while(list($field) = each($TCA_DESCR[$table]['columns'])) {
+ foreach ($GLOBALS['TCA_DESCR'][$key]['columns'] as $field => $_) {
- $fieldValue = isset($TCA[$table]) && strcmp($field,'') ? $TCA[$table]['columns'][$field] : array();
+ $fieldValue = isset($GLOBALS['TCA'][$key]) && strcmp($field, '') ? $GLOBALS['TCA'][$key]['columns'][$field] : array();
- if (is_array($fieldValue) && (!$this->limitAccess || !$fieldValue['exclude'] || $BE_USER->check('non_exclude_fields',$table.':'.$field))) {
+ if (is_array($fieldValue) && (!$this->limitAccess || !$fieldValue['exclude'] || $GLOBALS['BE_USER']->check('non_exclude_fields', $table . ':' . $field))) {
if (!$field) {
- $parts[0] = $this->printItem($table,'',1); // Header
+ $parts[0] = $this->printItem($key, '', 1); // Header
} else {
- $parts[] = $this->printItem($table,$field,1); // Field
+ $parts[] = $this->printItem($key, $field, 1); // Field
}
}
}
- if (!strcmp($parts,'')) unset($parts[0]);
- $output.= implode('<br />',$parts);
+ if (!$parts[0]) {
+ unset($parts[0]);
+ }
+ $output .= implode('<br />', $parts);
}
// Substitute glossary words:
- $output = $this->substituteGlossaryWords_nonHTML($output);
+ $output = $this->substituteGlossaryWords($output);
// TOC link:
- if (!$this->renderALL) {
- $tocLink = '<p class="c-nav"><a href="view_help.php">'.$LANG->getLL('goToToc',1).'</a></p>';
+ if (!$this->renderALL) {
+ $tocLink = '<p class="c-nav"><a href="view_help.php">' . $GLOBALS['LANG']->getLL('goToToc', 1) . '</a></p>';
$output =
$tocLink.'
/**
* Renders CSH for a single field.
*
- * @param string CSH key / table name
- * @param string Sub key / field name
- * @return string HTML output
+ * @param string $key CSH key / table name
+ * @param string $field Sub key / field name
+ * @return string HTML output
*/
- function render_Single($table,$field) {
- global $LANG, $TCA;
-
+ function render_Single($key, $field) {
$output = '';
- // Load descriptions for table $table
- $LANG->loadSingleTableDescription($table);
+ // Load the description field
+ $GLOBALS['LANG']->loadSingleTableDescription($key);
- // Render single item:
- $output.= $this->printItem($table,$field);
+ // Render single item
+ $output.= $this->printItem($key, $field);
// Substitute glossary words:
- $output = $this->substituteGlossaryWords_nonHTML($output);
+ $output = $this->substituteGlossaryWords($output);
// Link to Full table description and TOC:
$getLLKey = $this->limitAccess ? 'fullDescription' : 'fullDescription_module';
$output.= '<br />
- <p class="c-nav"><a href="view_help.php?tfID='.rawurlencode($table.'.*').'">'.$LANG->getLL($getLLKey,1).'</a></p>
- <p class="c-nav"><a href="view_help.php">'.$LANG->getLL('goToToc',1).'</a></p>';
+ <p class="c-nav"><a href="view_help.php?tfID=' . rawurlencode($key . '.*') . '">' . $GLOBALS['LANG']->getLL($getLLKey, 1) . '</a></p>
+ <p class="c-nav"><a href="view_help.php">' . $GLOBALS['LANG']->getLL('goToToc', 1) . '</a></p>';
return $output;
}
-
-
-
-
-
-
-
-
-
-
/************************************
*
* Rendering CSH items
* @return string See-also links HTML
*/
function make_seeAlso($value,$anchorTable='') {
- global $TCA,$BE_USER,$TCA_DESCR;
-
- // Split references by comma, vert.line or linebreak
- $items = split(',|'.chr(10),$value);
+ // Split references by comma or linebreak
+ $items = preg_split('/[,' . LF . ']/', $value);
$lines = array();
foreach($items as $val) {
// "table" reference
t3lib_div::loadTCA($iP[0]);
- if (!isset($TCA[$iP[0]]) || ((!$iP[1] || is_array($TCA[$iP[0]]['columns'][$iP[1]])) && (!$this->limitAccess || ($BE_USER->check('tables_select',$iP[0]) && (!$iP[1] || !$TCA[$iP[0]]['columns'][$iP[1]]['exclude'] || $BE_USER->check('non_exclude_fields',$iP[0].':'.$iP[1])))))) { // Checking read access:
+ if (!isset($GLOBALS['TCA'][$iP[0]]) || ((!$iP[1] || is_array($GLOBALS['TCA'][$iP[0]]['columns'][$iP[1]])) && (!$this->limitAccess || ($GLOBALS['BE_USER']->check('tables_select',$iP[0]) && (!$iP[1] || !$GLOBALS['TCA'][$iP[0]]['columns'][$iP[1]]['exclude'] || $GLOBALS['BE_USER']->check('non_exclude_fields',$iP[0].':'.$iP[1])))))) { // Checking read access:
// Load table descriptions:
- #$LANG->loadSingleTableDescription($iP[0]);
- if (isset($TCA_DESCR[$iP[0]])) {
+ #$GLOBALS['LANG']->loadSingleTableDescription($iP[0]);
+ if (isset($GLOBALS['TCA_DESCR'][$iP[0]])) {
// Make see-also link:
$href = ($this->renderALL || ($anchorTable && $iP[0]==$anchorTable) ? '#'.implode('.',$iP) : 'view_help.php?tfID='.rawurlencode(implode('.',$iP)).'&back='.$this->tfID);
$label = $this->getTableFieldLabel($iP[0],$iP[1],' / ');
// Splitting:
$imgArray = t3lib_div::trimExplode(',', $images, 1);
if (count($imgArray)) {
- $descrArray = explode(chr(10),$descr,count($imgArray));
-#debug($descrArray);
+ $descrArray = explode(LF,$descr,count($imgArray));
+
foreach($imgArray as $k => $image) {
$descr = $descrArray[$k];
$imgFile = '../'.$imgFile;
$code.= '<br /><img src="'.$imgFile.'" '.$imgInfo[3].' class="c-inlineimg" alt="" /><br />
';
- $code.= '<p><em>'.$GLOBALS['LANG']->hscAndCharConv($descr,1).'</em></p>
+ $code.= '<p><em>' . htmlspecialchars($descr) . '</em></p>
';
} else $code.= '<div style="background-color: red; border: 1px solid black; color: white;">NOT AN IMAGE: '.$imgFile.'</div>';
} else $code.= '<div style="background-color: red; border: 1px solid black; color: white;">IMAGE FILE NOT FOUND: '.$image.'</div>';
function headerLine($str,$type=0) {
switch($type) {
case 1:
- $str='<h3>'.htmlspecialchars($str).'</h3>
+ $str = '<h2 class="t3-row-header">' . htmlspecialchars($str) . '</h2>
';
break;
case 0:
- $str='<h4 class="uppercase">'.htmlspecialchars($str).'</h4>
+ $str = '<h3 class="divider">' . htmlspecialchars($str) . '</h3>
';
break;
}
* @return string Formatted content.
*/
function prepareContent($str) {
- $str = $GLOBALS['LANG']->hscAndCharConv($str,0);
return '<p>'.nl2br(trim(strip_tags($str,$this->allowedHTML))).'</p>
';
}
* Prints a single $table/$field information piece
* If $anchors is set, then seeAlso references to the same table will be page-anchors, not links.
*
- * @param string Table name
- * @param string Field name
- * @param boolean If anchors is to be shown.
- * @return string HTML content
+ * @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($table,$field,$anchors=0) {
- global $TCA_DESCR, $LANG, $TCA, $BE_USER;
+ function printItem($key, $field, $anchors = FALSE) {
+ $out = '';
- // Load full table definition in $TCA
- t3lib_div::loadTCA($table);
+ // Load full table definition in $GLOBALS['TCA']
+ t3lib_div::loadTCA($key);
- if ($table && (!$field || is_array($TCA_DESCR[$table]['columns'][$field]))) {
+ if ($key && (!$field || is_array($GLOBALS['TCA_DESCR'][$key]['columns'][$field]))) {
// Make seeAlso references.
- $seeAlsoRes = $this->make_seeAlso($TCA_DESCR[$table]['columns'][$field]['seeAlso'],$anchors?$table:'');
+ $seeAlsoRes = $this->make_seeAlso($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['seeAlso'], $anchors ? $key : '');
// Making item:
- $out= '<a name="'.$table.'.'.$field.'"></a>
- '.
- $this->headerLine($this->getTableFieldLabel($table,$field),1).
- $this->prepareContent($TCA_DESCR[$table]['columns'][$field]['description']).
- ($TCA_DESCR[$table]['columns'][$field]['details'] ? $this->headerLine($LANG->getLL('details').':').$this->prepareContent($TCA_DESCR[$table]['columns'][$field]['details']) : '').
- ($TCA_DESCR[$table]['columns'][$field]['syntax'] ? $this->headerLine($LANG->getLL('syntax').':').$this->prepareContent($TCA_DESCR[$table]['columns'][$field]['syntax']) : '').
- ($TCA_DESCR[$table]['columns'][$field]['image'] ? $this->printImage($TCA_DESCR[$table]['columns'][$field]['image'],$TCA_DESCR[$table]['columns'][$field]['image_descr']) : '').
- ($TCA_DESCR[$table]['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 />';
+ $out = '<a name="' . $key . '.' . $field . '"></a>' .
+ $this->headerLine($this->getTableFieldLabel($key, $field), 1) .
+ $this->prepareContent($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['description']) .
+ ($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['details'] ? $this->headerLine($GLOBALS['LANG']->getLL('details').':').$this->prepareContent($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['details']) : '') .
+ ($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['syntax'] ? $this->headerLine($GLOBALS['LANG']->getLL('syntax').':').$this->prepareContent($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['syntax']) : '') .
+ ($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['image'] ? $this->printImage($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['image'],$GLOBALS['TCA_DESCR'][$key]['columns'][$field]['image_descr']) : '') .
+ ($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['seeAlso'] && $seeAlsoRes ? $this->headerLine($GLOBALS['LANG']->getLL('seeAlso').':').'<p>'.$seeAlsoRes.'</p>' : '') .
+ ($this->back ? '<br /><p><a href="' . htmlspecialchars('view_help.php?tfID=' . rawurlencode($this->back)) . '" class="typo3-goBack">' . htmlspecialchars($GLOBALS['LANG']->getLL('goBack')) . '</a></p>' : '') .
+ '<br />';
}
return $out;
}
/**
- * Returns labels for $table and $field.
- * If $table is "_MOD_" prefixed, the part after "_MOD_" is returned (non-tables, fx. modules)
+ * Returns labels for a given field in a given structure
*
- * @param string Table name
- * @param string Field name
- * @return array Table and field labels in a numeric array
+ * @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($table,$field) {
- global $TCA, $TCA_DESCR, $LANG;
-
- $LANG->loadSingleTableDescription($table);
-
- $tableName = is_array($TCA_DESCR[$table]['columns']['']) && $TCA_DESCR[$table]['columns']['']['alttitle'] ?
- $TCA_DESCR[$table]['columns']['']['alttitle'] :
- (isset($TCA[$table]) ? $TCA[$table]['ctrl']['title'] : ereg_replace('^_MOD_','',$table));
- $fieldName = is_array($TCA_DESCR[$table]['columns'][$field]) && $TCA_DESCR[$table]['columns'][$field]['alttitle'] ?
- $TCA_DESCR[$table]['columns'][$field]['alttitle'] :
- (isset($TCA[$table])&&isset($TCA[$table]['columns'][$field]) ? $TCA[$table]['columns'][$field]['label'] : $field);
- return array($tableName,$fieldName);
+ function getTableFieldNames($key, $field) {
+ $GLOBALS['LANG']->loadSingleTableDescription($key);
+
+ // Define the label for the key
+ $keyName = $key;
+ if (is_array($GLOBALS['TCA_DESCR'][$key]['columns']['']) && isset($GLOBALS['TCA_DESCR'][$key]['columns']['']['alttitle'])) {
+ // If there's an alternative title, use it
+ $keyName = $GLOBALS['TCA_DESCR'][$key]['columns']['']['alttitle'];
+ } elseif (isset($GLOBALS['TCA'][$key])) {
+ // Otherwise, if it's a table, use its title
+ $keyName = $GLOBALS['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($GLOBALS['TCA_DESCR'][$key]['columns'][$field]) && isset($GLOBALS['TCA_DESCR'][$key]['columns'][$field]['alttitle'])) {
+ // If there's an alternative title, use it
+ $fieldName = $GLOBALS['TCA_DESCR'][$key]['columns'][$field]['alttitle'];
+ } elseif (isset($GLOBALS['TCA'][$key]) && isset($GLOBALS['TCA'][$key]['columns'][$field])) {
+ // Otherwise, if it's a table, use its title
+ $fieldName = $GLOBALS['TCA'][$key]['columns'][$field]['label'];
+ }
+ return array($keyName, $fieldName);
}
/**
* Returns composite label for table/field
*
- * @param string Table name
- * @param string Field name
- * @param string Token to merge the two strings with.
- * @return array Table and field labels in a numeric array
+ * @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
* @see getTableFieldNames()
*/
- function getTableFieldLabel($table,$field='',$mergeToken=': ') {
- global $LANG;
+ function getTableFieldLabel($key, $field = '', $mergeToken = ': ') {
+ $tableName = '';
+ $fieldName = '';
// Get table / field parts:
- list($tableName,$fieldName) = $this->getTableFieldNames($table,$field);
+ list($tableName, $fieldName) = $this->getTableFieldNames($key, $field);
// Create label:
- $labelStr = $LANG->sL($tableName).
- ($field ? $mergeToken.ereg_replace(':$','', trim($LANG->sL($fieldName))):'');
+ $labelString = $GLOBALS['LANG']->sL($tableName) .
+ ($field ? $mergeToken . rtrim(trim($GLOBALS['LANG']->sL($fieldName)), ':') : '');
- return $labelStr;
+ return $labelString;
}
+
+
+
+
+
+
+
+
+
+
+ /******************************
+ *
+ * Glossary related
+ *
+ ******************************/
+
/**
* Creates glossary index in $this->glossaryWords
+ * Glossary is cached in cache_hash cache and so will be updated only when cache is cleared.
*
* @return void
- * @todo: Implement some caching of this array - needed when the glossary grows to a large size!
*/
function createGlossaryIndex() {
- global $TCA_DESCR,$TCA,$LANG;
-
- // Initialize:
- $CSHkeys = array_flip(array_keys($TCA_DESCR));
-
- // Glossary
- foreach($CSHkeys as $cshKey => $value) {
- if (t3lib_div::isFirstPartOfStr($cshKey, 'xGLOSSARY_') && !isset($TCA[$cshKey])) {
- $LANG->loadSingleTableDescription($cshKey);
-
- if (is_array($TCA_DESCR[$cshKey]['columns'])) {
-
- // Traverse table columns as listed in TCA_DESCR
- reset($TCA_DESCR[$cshKey]['columns']);
- while(list($field,$data) = each($TCA_DESCR[$cshKey]['columns'])) {
- if ($field) {
- $this->glossaryWords[$cshKey.'.'.$field] = array(
- 'title' => trim($data['alttitle'] ? $data['alttitle'] : $cshKey),
- 'description' => $data['description'],
- );
+ // Create hash string and try to retrieve glossary array:
+ $hash = md5('typo3/view_help.php:glossary');
+ list($this->glossaryWords,$this->substWords) = unserialize(t3lib_BEfunc::getHash($hash));
+
+ // Generate glossary words if not found:
+ if (!is_array($this->glossaryWords)) {
+
+ // Initialize:
+ $this->glossaryWords = array();
+ $this->substWords = array();
+ $CSHkeys = array_flip(array_keys($GLOBALS['TCA_DESCR']));
+
+ // Glossary
+ foreach($CSHkeys as $cshKey => $value) {
+ if (t3lib_div::isFirstPartOfStr($cshKey, 'xGLOSSARY_') && !isset($GLOBALS['TCA'][$cshKey])) {
+ $GLOBALS['LANG']->loadSingleTableDescription($cshKey);
+
+ if (is_array($GLOBALS['TCA_DESCR'][$cshKey]['columns'])) {
+
+ // Traverse table columns as listed in TCA_DESCR
+ foreach ($GLOBALS['TCA_DESCR'][$cshKey]['columns'] as $field => $data) {
+ if ($field) {
+ $this->glossaryWords[$cshKey.'.'.$field] = array(
+ 'title' => trim($data['alttitle'] ? $data['alttitle'] : $cshKey),
+ 'description' => str_replace('%22','%23%23%23', rawurlencode($data['description'])),
+ );
+ }
}
}
}
}
+
+ // First, create unique list of words:
+ foreach($this->glossaryWords as $key => $value) {
+ $word = strtolower($value['title']); // Making word lowercase in order to filter out same words in different cases.
+
+ if ($word!=='') {
+ $this->substWords[$word] = $value;
+ $this->substWords[$word]['key'] = $key;
+ }
+ }
+
+ krsort($this->substWords);
+
+ t3lib_BEfunc::storeHash($hash,serialize(array($this->glossaryWords,$this->substWords)),'Glossary');
}
-#debug($this->glossaryWords);
+ }
+
+ /**
+ * Processing of all non-HTML content in the output
+ * Will be done by a call-back to ->substituteGlossaryWords_htmlcleaner_callback()
+ *
+ * @param string Input HTML code
+ * @return string Output HTML code
+ */
+ function substituteGlossaryWords($code) {
+ $htmlParser = t3lib_div::makeInstance('local_t3lib_parsehtml');
+ $htmlParser->pObj = $this;
+ $code = $htmlParser->HTMLcleaner($code, array(), 1);
+
+ return $code;
}
/**
* Substituting glossary words in the CSH
+ * (This is a call-back function from "class local_t3lib_parsehtml extends t3lib_parsehtml", see top of this script)
*
* @param string Input HTML string
* @return string HTML with substituted words in.
- * @todo It is certain that the substitution of words could be improved. This is just a basic implementation. Suggestions are welcome!
+ * @coauthor alex widschwendter, media.res kommunikationsloesungen
*/
- function substituteGlossaryWords($code) {
- if (is_array($this->glossaryWords) && strlen(trim($code))) {
-#debug(array($code),1);
- // First, create unique list of words:
- $substWords = array();
- foreach($this->glossaryWords as $key => $value) {
- $word = strtolower($value['title']); // Making word lowercase in order to filter out same words in different cases.
-
- if ($word!=='') {
- $substWords[$word] = $value;
- $substWords[$word]['key'] = $key;
- }
- }
+ function substituteGlossaryWords_htmlcleaner_callback($code) {
+ if (is_array($this->substWords) && count($this->substWords) && strlen(trim($code))) {
// Substitute words:
- foreach($substWords as $wordSet) {
- $parts = preg_split("/([^[:alnum:]]+)(".$wordSet['title'].")([^[:alnum:]]+)/", ' '.$code.' ', 2, PREG_SPLIT_DELIM_CAPTURE);
+ foreach($this->substWords as $wordKey => $wordSet) {
+ // quoteMeta used so special chars (which should not occur though) in words will not break the regex. Seemed to work (- kasper)
+ $parts = preg_split('/( |[\(])('.quoteMeta($wordSet['title']).')([\.\!\)\?\:\,]+| )/i', ' '.$code.' ', 2, PREG_SPLIT_DELIM_CAPTURE);
if (count($parts) == 5) {
- $parts[2] = '<a style="background-color: yellow; " href="'.htmlspecialchars('view_help.php?tfID='.rawurlencode($wordSet['key']).'&back='.$this->tfID).'" title="'.htmlspecialchars($wordSet['description']).'">'.$parts[2].'</a>';
-#debug($parts,$word);
-#debug($wordSet['title']);
+ $parts[2] = '<a class="glossary-term" href="'.htmlspecialchars('view_help.php?tfID='.rawurlencode($wordSet['key']).'&back='.$this->tfID).'" title="'.rawurlencode(htmlspecialchars(t3lib_div::fixed_lgd_cs(rawurldecode($wordSet['description']),80))).'">'.
+ htmlspecialchars($parts[2]).
+ '</a>';
$code = substr(implode('',$parts),1,-1);
// Disable entry so it doesn't get used next time:
- unset($this->glossaryWords[$wordSet['key']]);
+ unset($this->substWords[$wordKey]);
}
}
+ $code = str_replace('###', '"',rawurldecode($code));
}
return $code;
}
- function substituteGlossaryWords_nonHTML($code) {
- $htmlParser = t3lib_div::makeInstance('local_t3lib_parsehtml');
- $htmlParser->pObj = &$this;
- $code = $htmlParser->HTMLcleaner($code, array(), 1);
-
- return $code;
- }
-}
-
-
-// Include extension?
-if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/view_help.php']) {
- include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/view_help.php']);
}
+if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/view_help.php'])) {
+ include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/view_help.php']);
+}
$SOBE->init();
$SOBE->main();
$SOBE->printContent();
+
?>
\ No newline at end of file
projects / Packages / TYPO3.CMS.git / blobdiff