SC_view_help Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	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)
Öffentliche Attribute
	$allowedHTML = '<strong><em><b><i>'
	$limitAccess
	$table
	$field
	$tfID
	$ffID
	$back
	$renderALL
	$content
	$glossaryWords

---

Dokumentation der Elementfunktionen

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.

Rückgabe:

void

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

Returns composite label for table/field

Parameter:

	string	Table name
	string	Field name
	string	Token to merge the two strings with.

Rückgabe:

array Table and field labels in a numeric array

Siehe auch:

getTableFieldNames()

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)

Parameter:

	string	Table name
	string	Field name

Rückgabe:

array Table and field labels in a numeric array

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

Returns header HTML content

Parameter:

	string	Header text
	string	Header type (1, 0)

Rückgabe:

string The HTML for the header.

SC_view_help::init

(

)

Initialize the class for various input etc.

Rückgabe:

void

SC_view_help::main

(

)

Main function, rendering the display

Rückgabe:

void

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

Make seeAlso links from $value

Parameter:

	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.

Rückgabe:

string See-also links HTML

SC_view_help::prepareContent

(

$

str

)

Returns prepared content

Parameter:

string

Content to format.

Rückgabe:

string Formatted content.

SC_view_help::printContent

(

)

Outputting the accumulated content to screen

Rückgabe:

void

SC_view_help::printImage	(	$	images,
		$	descr
	)

Will return an image tag with description in italics.

Parameter:

	string	Image file reference (list of)
	string	Description string (divided for each image by line break)

Rückgabe:

string Image HTML codes

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.

Parameter:

	string	Table name
	string	Field name
	boolean	If anchors is to be shown.

Rückgabe:

string HTML content

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.

Parameter:

	string	Table name
	string	Field name
	boolean	If anchors is to be shown.

Rückgabe:

string HTML content

SC_view_help::render_Single	(	$	table,
		$	field
	)

Renders CSH for a single field.

Parameter:

	string	CSH key / table name
	string	Sub key / field name

Rückgabe:

string HTML output

SC_view_help::render_SingleFlex

(

)

Renders CSH for a single field.

Parameter:

	string	CSH key / table name
	string	Sub key / field name

Rückgabe:

string HTML output

SC_view_help::render_Table

(

$

table

)

Render CSH for a full cshKey/table

Parameter:

string

CSH key / table name

Rückgabe:

string HTML output

SC_view_help::render_TOC

(

)

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

Rückgabe:

string HTML content

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.

Parameter:

	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!

Rückgabe:

void

SC_view_help::render_TOC_makeTocList

(

$

tocArray

)

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

Parameter:

array

ToC Array.

Rückgabe:

string HTML bullet list for index.

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()

Parameter:

string

Input HTML code

Rückgabe:

string Output HTML code

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)

Parameter:

string

Input HTML string

Rückgabe:

string HTML with substituted words in. alex widschwendter, media.res kommunikationsloesungen

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/view_help.php