SC_view_help Class Reference

List of all members.

Public Member Functions

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

Public Attributes

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

Detailed Description

Definition at line 122 of file view_help.php.

Member Function Documentation

SC_view_help::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

Definition at line 773 of file view_help.php.

References $field, $key, $TCA, $value, t3lib_BEfunc::getHash(), t3lib_div::isFirstPartOfStr(), and t3lib_BEfunc::storeHash().

Referenced by main().

SC_view_help::getTableFieldLabel ( $  table,
$  field = '',
$  mergeToken = ': ' 
)

Returns composite label for table/field

Parameters:
string Table name
string Field name
string Token to merge the two strings with.
Returns:
array Table and field labels in a numeric array
See also:
getTableFieldNames()

Definition at line 738 of file view_help.php.

References $field, $table, and getTableFieldNames().

Referenced by make_seeAlso(), and printItem().

SC_view_help::getTableFieldNames ( $  table,
$  field 
)

Returns labels for $table and $field. If $table is "_MOD_" prefixed, the part after "_MOD_" is returned (non-tables, fx. modules)

Parameters:
string Table name
string Field name
Returns:
array Table and field labels in a numeric array

Definition at line 715 of file view_help.php.

References $field, $table, and $TCA.

Referenced by getTableFieldLabel().

SC_view_help::headerLine ( $  str,
$  type = 0 
)

Returns header HTML content

Parameters:
string Header text
string Header type (1, 0)
Returns:
string The HTML for the header.

Definition at line 617 of file view_help.php.

Referenced by printItem(), and printItemFlex().

SC_view_help::init (  ) 

Initialize the class for various input etc.

Returns:
void

Definition at line 147 of file view_help.php.

References $GLOBALS, $TCA, t3lib_div::_GP(), and t3lib_BEfunc::isModuleSetInTBE_MODULES().

SC_view_help::main (  ) 

Main function, rendering the display

Returns:
void

Definition at line 173 of file view_help.php.

References $TCA, createGlossaryIndex(), render_Single(), render_SingleFlex(), render_Table(), and render_TOC().

SC_view_help::make_seeAlso ( $  value,
$  anchorTable = '' 
)

Make seeAlso links from $value

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

Definition at line 533 of file view_help.php.

References $lines, $TCA, $val, $value, t3lib_div::getFileAbsFileName(), getTableFieldLabel(), t3lib_div::loadTCA(), and t3lib_div::trimExplode().

Referenced by printItem(), and printItemFlex().

SC_view_help::prepareContent ( $  str  ) 

Returns prepared content

Parameters:
string Content to format.
Returns:
string Formatted content.

Definition at line 638 of file view_help.php.

References $GLOBALS.

Referenced by printItem(), and printItemFlex().

SC_view_help::printContent (  ) 

Outputting the accumulated content to screen

Returns:
void

Definition at line 206 of file view_help.php.

SC_view_help::printImage ( $  images,
$  descr 
)

Will return an image tag with description in italics.

Parameters:
string Image file reference (list of)
string Description string (divided for each image by line break)
Returns:
string Image HTML codes

Definition at line 582 of file view_help.php.

References t3lib_div::getFileAbsFileName(), and t3lib_div::trimExplode().

Referenced by printItem(), and printItemFlex().

SC_view_help::printItem ( $  table,
$  field,
$  anchors = 0 
)

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 Table name
string Field name
boolean If anchors is to be shown.
Returns:
string HTML content

Definition at line 653 of file view_help.php.

References $field, $table, $TCA, getTableFieldLabel(), headerLine(), t3lib_div::loadTCA(), make_seeAlso(), prepareContent(), and printImage().

Referenced by render_Single(), and render_Table().

SC_view_help::printItemFlex (  ) 

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 Table name
string Field name
boolean If anchors is to be shown.
Returns:
string HTML content

Definition at line 687 of file view_help.php.

References $GLOBALS, headerLine(), make_seeAlso(), prepareContent(), and printImage().

Referenced by render_SingleFlex().

SC_view_help::render_Single ( $  table,
$  field 
)

Renders CSH for a single field.

Parameters:
string CSH key / table name
string Sub key / field name
Returns:
string HTML output

Definition at line 478 of file view_help.php.

References $field, $table, $TCA, printItem(), and substituteGlossaryWords().

Referenced by main().

SC_view_help::render_SingleFlex (  ) 

Renders CSH for a single field.

Parameters:
string CSH key / table name
string Sub key / field name
Returns:
string HTML output

Definition at line 509 of file view_help.php.

References printItemFlex(), and substituteGlossaryWords().

Referenced by main().

SC_view_help::render_Table ( $  table  ) 

Render CSH for a full cshKey/table

Parameters:
string CSH key / table name
Returns:
string HTML output

Definition at line 418 of file view_help.php.

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

Referenced by main(), and render_TOC_el().

SC_view_help::render_TOC (  ) 

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

Returns:
string HTML content

Definition at line 229 of file view_help.php.

References $loadModules, $table, $TCA, $value, t3lib_div::isFirstPartOfStr(), t3lib_div::makeInstance(), render_TOC_el(), and render_TOC_makeTocList().

Referenced by main().

SC_view_help::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 CSH key / Table name
string TOC category keyword: "core", "modules", "tables", "other"
array Array for accumulation of rendered HELP Content (in "renderALL" mode). Passed by reference!
array TOC array; Here TOC index elements are created. Passed by reference!
array CSH 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

Definition at line 347 of file view_help.php.

References $table, and render_Table().

Referenced by render_TOC().

SC_view_help::render_TOC_makeTocList ( $  tocArray  ) 

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

Parameters:
array ToC Array.
Returns:
string HTML bullet list for index.

Definition at line 379 of file view_help.php.

Referenced by render_TOC().

SC_view_help::substituteGlossaryWords ( $  code  ) 

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

Parameters:
string Input HTML code
Returns:
string Output HTML code

Definition at line 832 of file view_help.php.

References t3lib_div::makeInstance().

Referenced by render_Single(), render_SingleFlex(), and render_Table().

SC_view_help::substituteGlossaryWords_htmlcleaner_callback ( $  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)

Parameters:
string Input HTML string
Returns:
string HTML with substituted words in. alex widschwendter, media.res kommunikationsloesungen

Definition at line 848 of file view_help.php.

Member Data Documentation

SC_view_help::$allowedHTML = '<strong><em><b><i>'

Definition at line 123 of file view_help.php.

SC_view_help::$back

Definition at line 133 of file view_help.php.

SC_view_help::$content

Definition at line 137 of file view_help.php.

SC_view_help::$ffID

Definition at line 132 of file view_help.php.

SC_view_help::$field

Definition at line 128 of file view_help.php.

Referenced by createGlossaryIndex(), getTableFieldLabel(), getTableFieldNames(), printItem(), render_Single(), and render_Table().

SC_view_help::$glossaryWords

Definition at line 138 of file view_help.php.

SC_view_help::$limitAccess

Definition at line 126 of file view_help.php.

SC_view_help::$renderALL

Definition at line 134 of file view_help.php.

SC_view_help::$table

Definition at line 127 of file view_help.php.

Referenced by getTableFieldLabel(), getTableFieldNames(), printItem(), render_Single(), render_Table(), render_TOC(), and render_TOC_el().

SC_view_help::$tfID

Definition at line 131 of file view_help.php.

The documentation for this class was generated from the following file:
Generated on Sat Jan 3 04:23:44 2009 for TYPO3 API by  doxygen 1.4.7