TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Cshmanual\Controller\HelpModuleController Class Reference
Inheritance diagram for TYPO3\CMS\Cshmanual\Controller\HelpModuleController:
SC_view_help

Public Member Functions

 init ()
 
 main ()
 
 printContent ()
 
 render_TOC ()
 
 render_TOC_el ($table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)
 
 render_TOC_makeTocList ($tocArray)
 
 render_Table ($key, $table=NULL)
 
 render_Single ($key, $field)
 
 make_seeAlso ($value, $anchorTable='')
 
 printImage ($images, $descr)
 
 headerLine ($str, $type=0)
 
 prepareContent ($str)
 
 printItem ($key, $field, $anchors=FALSE)
 
 getTableFieldNames ($key, $field)
 
 getTableFieldLabel ($key, $field='', $mergeToken=':')
 
 createGlossaryIndex ()
 
 substituteGlossaryWords ($code)
 
 substituteGlossaryWords_htmlcleaner_callback ($code)
 

Public Attributes

 $allowedHTML = '<strong><em><b><i>'
 
 $limitAccess
 
 $table
 
 $field
 
 $tfID
 
 $back
 
 $renderALL
 
 $content
 
 $glossaryWords
 

Protected Attributes

 $mainKey
 
 $moduleUrl
 

Detailed Description

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 Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 26 of file HelpModuleController.php.

Member Function Documentation

◆ createGlossaryIndex()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::createGlossaryIndex ( )

Creates glossary index in $this->glossaryWords Glossary is cached in cache_hash cache and so will be updated only when cache is cleared.

Returns
void
Todo:
Define visibility

Definition at line 634 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\getHash(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Backend\Utility\BackendUtility\storeHash().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\main().

◆ getTableFieldLabel()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::getTableFieldLabel (   $key,
  $field = '',
  $mergeToken = ': ' 
)

Returns composite label for table/field

Parameters
string$keyCSH key / table name
string$fieldSub key / field name
string$mergeTokenToken to merge the two strings with
Returns
string Labels joined with merge token
See also
getTableFieldNames()
Todo:
Define visibility

Definition at line 615 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, $GLOBALS, and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldNames().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\make_seeAlso(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC_el().

◆ getTableFieldNames()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::getTableFieldNames (   $key,
  $field 
)

Returns labels for a given field in a given structure

Parameters
string$keyCSH key / table name
string$fieldSub key / field name
Returns
array Table and field labels in a numeric array
Todo:
Define visibility

Definition at line 579 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, and $GLOBALS.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldLabel().

◆ headerLine()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::headerLine (   $str,
  $type = 0 
)

Returns header HTML content

Parameters
string$strHeader text
integer$typeHeader type (1, 0)
Returns
string The HTML for the header.
Todo:
Define visibility

Definition at line 524 of file HelpModuleController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem().

◆ init()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::init ( )

Initialize the class for various input etc.

Returns
void
Todo:
Define visibility

Definition at line 112 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$table, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), and TYPO3\CMS\Backend\Utility\BackendUtility\isModuleSetInTBE_MODULES().

◆ main()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::main ( )

Main function, rendering the display

Returns
void
Todo:
Define visibility

Definition at line 161 of file HelpModuleController.php.

References $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\createGlossaryIndex(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Single(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Table(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC().

◆ make_seeAlso()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::make_seeAlso (   $value,
  $anchorTable = '' 
)

Make seeAlso links from $value

Parameters
string$valueSee-also input codes
string$anchorTableIf $anchorTable is set to a tablename, then references to this table will be made as anchors, not URLs.
Returns
string See-also links HTML
Todo:
Define visibility

Definition at line 444 of file HelpModuleController.php.

References $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$tfID, TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldLabel(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem().

◆ prepareContent()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::prepareContent (   $str)

Returns prepared content

Parameters
string$strContent to format.
Returns
string Formatted content.
Todo:
Define visibility

Definition at line 545 of file HelpModuleController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem().

◆ printContent()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::printContent ( )

Outputting the accumulated content to screen

Returns
void
Todo:
Define visibility

Definition at line 191 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$content.

◆ printImage()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::printImage (   $images,
  $descr 
)

Will return an image tag with description in italics.

Parameters
string$imagesImage file reference (list of)
string$descrDescription string (divided for each image by line break)
Returns
string Image HTML codes
Todo:
Define visibility

Definition at line 487 of file HelpModuleController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem().

◆ printItem()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::printItem (   $key,
  $field,
  $anchors = FALSE 
)

Prints a single $table/$field information piece If $anchors is set, then seeAlso references to the same table will be page-anchors, not links.

Parameters
string$keyCSH key / table name
string$fieldSub key / field name
boolean$anchorsIf anchors is to be shown.
Returns
string HTML content
Todo:
Define visibility

Definition at line 560 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldLabel(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\headerLine(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\make_seeAlso(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\prepareContent(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printImage().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Single(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Table().

◆ render_Single()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::render_Single (   $key,
  $field 
)

Renders CSH for a single field.

Parameters
string$keyCSH key / table name
string$fieldSub key / field name
Returns
string HTML output
Todo:
Define visibility

Definition at line 416 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\substituteGlossaryWords().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\main().

◆ render_Table()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::render_Table (   $key,
  $table = NULL 
)

Render CSH for a full cshKey/table

Parameters
string$keyFull CSH key (may be different from table name)
string$tableCSH key / table name
Returns
string HTML output
Todo:
Define visibility

Definition at line 365 of file HelpModuleController.php.

References TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$field, $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$table, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\substituteGlossaryWords().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\main(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC_el().

◆ render_TOC()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::render_TOC ( )

Creates Table Of Contents and possibly "Full Manual" mode if selected.

Returns
string HTML content
Todo:
Define visibility

Definition at line 205 of file HelpModuleController.php.

References $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$table, TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC_el(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC_makeTocList(), and TYPO3\CMS\Backend\Utility\BackendUtility\TYPO3_copyRightNotice().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\main().

◆ render_TOC_el()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::render_TOC_el (   $table,
  $tocCat,
&  $outputSections,
&  $tocArray,
&  $CSHkeys 
)

Creates a TOC list element and renders corresponding HELP content if "renderALL" mode is set.

Parameters
string$tableCSH key / Table name
string$tocCatTOC category keyword: "core", "modules", "tables", "other @param array $outputSections Array for accumulation of rendered HELP Content (in "renderALL" mode). Passed by reference!
array$tocArrayTOC array; Here TOC index elements are created. Passed by reference!
array$CSHkeysCSH keys array. Every item rendered will be unset in this array so finally we can see what CSH keys are not processed yet. Passed by reference!
Returns
void
Todo:
Define visibility

Definition at line 298 of file HelpModuleController.php.

References $GLOBALS, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\$table, TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldLabel(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Table().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC().

◆ render_TOC_makeTocList()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::render_TOC_makeTocList (   $tocArray)

Renders the TOC index as a HTML bullet list from TOC array

Parameters
array$tocArrayToC Array.
Returns
string HTML bullet list for index.
Todo:
Define visibility

Definition at line 329 of file HelpModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC().

◆ substituteGlossaryWords()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::substituteGlossaryWords (   $code)

Processing of all non-HTML content in the output Will be done by a call-back to ->substituteGlossaryWords_htmlcleaner_callback()

Parameters
string$codeInput HTML code
Returns
string Output HTML code
Todo:
Define visibility

Definition at line 685 of file HelpModuleController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Single(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Table().

◆ substituteGlossaryWords_htmlcleaner_callback()

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::substituteGlossaryWords_htmlcleaner_callback (   $code)

Substituting glossary words in the CSH This is a call-back function from "class local_t3lib_parsehtml extends \TYPO3\CMS\Core\Html\HtmlParser", see top of this script

Parameters
string$codeInput HTML string
Returns
string HTML with substituted words in.
Todo:
Define visibility

Definition at line 701 of file HelpModuleController.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs().

Member Data Documentation

◆ $allowedHTML

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$allowedHTML = '<strong><em><b><i>'
Todo:
Define visibility

Definition at line 31 of file HelpModuleController.php.

◆ $back

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$back

Back (previous tfID)

Todo:
Define visibility

Definition at line 76 of file HelpModuleController.php.

◆ $content

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$content

Content accumulation

Todo:
Define visibility

Definition at line 90 of file HelpModuleController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printContent().

◆ $field

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$field

The "field" key

Todo:
Define visibility

Definition at line 53 of file HelpModuleController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\createGlossaryIndex(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldLabel(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\getTableFieldNames(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\init(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printItem(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Single(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Table().

◆ $glossaryWords

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$glossaryWords

Glossary words

Todo:
Define visibility

Definition at line 97 of file HelpModuleController.php.

◆ $limitAccess

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$limitAccess

For these vars, see init() If set access to fields and tables is checked. Should be done for TRUE database tables.

Todo:
Define visibility

Definition at line 39 of file HelpModuleController.php.

◆ $mainKey

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$mainKey
protected

Definition at line 61 of file HelpModuleController.php.

◆ $moduleUrl

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$moduleUrl
protected

Definition at line 104 of file HelpModuleController.php.

◆ $renderALL

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$renderALL

If set, then in TOC mode the FULL manual will be printed as well!

Todo:
Define visibility

Definition at line 83 of file HelpModuleController.php.

◆ $table

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$table

The "table" key

Todo:
Define visibility

Definition at line 46 of file HelpModuleController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\init(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_Table(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC(), and TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC_el().

◆ $tfID

TYPO3\CMS\Cshmanual\Controller\HelpModuleController::$tfID

Internal, static: GPvar Table/Field id

Todo:
Define visibility

Definition at line 69 of file HelpModuleController.php.

Referenced by TYPO3\CMS\Cshmanual\Controller\HelpModuleController\make_seeAlso().