Documentation TYPO3 par Ameos

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)
 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=': ')

Public Attributes

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

Detailed Description

Definition at line 88 of file view_help.php.


Member Function Documentation

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 639 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 616 of file view_help.php.

References $field, and $table.

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 547 of file view_help.php.

Referenced by printItem().

SC_view_help::init  ) 
 

Initialize the class for various input etc.

Returns:
void

Definition at line 111 of file view_help.php.

References t3lib_div::_GP().

SC_view_help::main  ) 
 

Main function, rendering the display

Returns:
void

Definition at line 131 of file view_help.php.

References render_Single(), 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 463 of file view_help.php.

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

Referenced by printItem().

SC_view_help::prepareContent str  ) 
 

Returns prepared content

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

Definition at line 568 of file view_help.php.

Referenced by printItem().

SC_view_help::printContent  ) 
 

Outputting the accumulated content to screen

Returns:
void

Definition at line 160 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 512 of file view_help.php.

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

Referenced by printItem().

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 583 of file view_help.php.

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

Referenced by render_Single(), and render_Table().

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 420 of file view_help.php.

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

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 363 of file view_help.php.

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

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 183 of file view_help.php.

References $table, 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 292 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 324 of file view_help.php.

Referenced by render_TOC().


The documentation for this class was generated from the following file:


Généré par Les spécialistes TYPO3 avec  doxygen 1.4.6