Solutions Open Source

Référence de la classe SC_view_help

Liste de tous les membres

Fonctions membres publiques
	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)
Attributs publics
	$allowedHTML = '<strong><em><b><i>'
	$limitAccess
	$table
	$field
	$tfID
	$back
	$renderALL
	$content
	$glossaryWords

---

Documentation des fonctions membres

SC_view_help::init

(

)

Initialize the class for various input etc.

Renvoie:

void

SC_view_help::main

(

)

Main function, rendering the display

Renvoie:

void

SC_view_help::printContent

(

)

Outputting the accumulated content to screen

Renvoie:

void

SC_view_help::render_TOC

(

)

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

Renvoie:

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.

Paramètres:

	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!

Renvoie:

void

SC_view_help::render_TOC_makeTocList

(

$

tocArray

)

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

Paramètres:

array

ToC Array.

Renvoie:

string HTML bullet list for index.

SC_view_help::render_Table

(

$

table

)

Render CSH for a full cshKey/table

Paramètres:

string

CSH key / table name

Renvoie:

string HTML output

SC_view_help::render_Single	(	$	table,
		$	field
	)

Renders CSH for a single field.

Paramètres:

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

Renvoie:

string HTML output

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

Make seeAlso links from $value

Paramètres:

	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.

Renvoie:

string See-also links HTML

SC_view_help::printImage	(	$	images,
		$	descr
	)

Will return an image tag with description in italics.

Paramètres:

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

Renvoie:

string Image HTML codes

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

Returns header HTML content

Paramètres:

	string	Header text
	string	Header type (1, 0)

Renvoie:

string The HTML for the header.

SC_view_help::prepareContent

(

$

str

)

Returns prepared content

Paramètres:

string

Content to format.

Renvoie:

string Formatted content.

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.

Paramètres:

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

Renvoie:

string HTML content

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)

Paramètres:

	string	Table name
	string	Field name

Renvoie:

array Table and field labels in a numeric array

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

Returns composite label for table/field

Paramètres:

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

Renvoie:

array Table and field labels in a numeric array

Voir également:

getTableFieldNames()

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.

Renvoie:

void

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

Paramètres:

string

Input HTML code

Renvoie:

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)

Paramètres:

string

Input HTML string

Renvoie:

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

---

Documentation des données membres

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

SC_view_help::$limitAccess

SC_view_help::$table

SC_view_help::$field

SC_view_help::$tfID

SC_view_help::$back

SC_view_help::$renderALL

SC_view_help::$content

SC_view_help::$glossaryWords

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Z:/doxygen/typo3_src-4.1.2/typo3/view_help.php

---