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) | |
| make_seeAlso ($value, $anchorTable='') | |
| printImage ($images, $descr) | |
| headerLine ($str, $type=0) | |
| prepareContent ($str) | |
| printItem ($table, $field, $anchors=0) | |
| 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 | |
| $back | |
| $renderALL | |
| $content | |
| $glossaryWords | |
Definition at line 122 of file view_help.php.
| SC_view_help::init | ( | ) |
Initialize the class for various input etc.
Definition at line 146 of file view_help.php.
| SC_view_help::main | ( | ) |
| SC_view_help::printContent | ( | ) |
Outputting the accumulated content to screen
Definition at line 198 of file view_help.php.
| SC_view_help::render_TOC | ( | ) |
Creates Table Of Contents and possibly "Full Manual" mode if selected.
Definition at line 221 of file view_help.php.
| 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.
| 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! |
Definition at line 338 of file view_help.php.
| SC_view_help::render_TOC_makeTocList | ( | $ | tocArray | ) |
Renders the TOC index as a HTML bullet list from TOC array
| array | ToC Array. |
Definition at line 370 of file view_help.php.
| SC_view_help::render_Table | ( | $ | table | ) |
Render CSH for a full cshKey/table
| string | CSH key / table name |
Definition at line 409 of file view_help.php.
| SC_view_help::render_Single | ( | $ | table, | |
| $ | field | |||
| ) |
Renders CSH for a single field.
| string | CSH key / table name | |
| string | Sub key / field name |
Definition at line 469 of file view_help.php.
| SC_view_help::make_seeAlso | ( | $ | value, | |
| $ | anchorTable = '' | |||
| ) |
Make seeAlso links from $value
| 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. |
Definition at line 515 of file view_help.php.
| SC_view_help::printImage | ( | $ | images, | |
| $ | descr | |||
| ) |
Will return an image tag with description in italics.
| string | Image file reference (list of) | |
| string | Description string (divided for each image by line break) |
Definition at line 564 of file view_help.php.
| SC_view_help::headerLine | ( | $ | str, | |
| $ | type = 0 | |||
| ) |
Returns header HTML content
| string | Header text | |
| string | Header type (1, 0) |
Definition at line 599 of file view_help.php.
| SC_view_help::prepareContent | ( | $ | str | ) |
Returns prepared content
| string | Content to format. |
Definition at line 620 of file view_help.php.
| 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.
| string | Table name | |
| string | Field name | |
| boolean | If anchors is to be shown. |
Definition at line 635 of file view_help.php.
| 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)
| string | Table name | |
| string | Field name |
Definition at line 668 of file view_help.php.
| SC_view_help::getTableFieldLabel | ( | $ | table, | |
| $ | field = '', |
|||
| $ | mergeToken = ': ' | |||
| ) |
Returns composite label for table/field
| string | Table name | |
| string | Field name | |
| string | Token to merge the two strings with. |
Definition at line 691 of file view_help.php.
| SC_view_help::createGlossaryIndex | ( | ) |
Creates glossary index in $this->glossaryWords Glossary is cached in cache_hash table and so will be updated only when cache is cleared.
Definition at line 726 of file view_help.php.
| 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()
| string | Input HTML code |
Definition at line 785 of file view_help.php.
| 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)
| string | Input HTML string |
Definition at line 801 of file view_help.php.