t3lib_rteapi Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	isAvailable ()
	drawRTE (&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue)
	transformContent ($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid)
	triggerField ($fieldName)
Öffentliche Attribute
	$errorLog = array()
	$ID = ''

---

Dokumentation der Elementfunktionen

t3lib_rteapi::drawRTE	(	&$	pObj,
		$	table,
		$	field,
		$	row,
		$	PA,
		$	specConf,
		$	thisConfig,
		$	RTEtypeVal,
		$	RTErelPath,
		$	thePidValue
	)

Draws the RTE as a form field or whatever is needed (inserts JavaApplet, creates iframe, renders ....) Default is to output the transformed content in a plain textarea field. This mode is great for debugging transformations!

Parameter:

	object	Reference to parent object, which is an instance of the TCEforms.
	string	The table name
	string	The field name
	array	The current row from which field is being rendered
	array	Array of standard content for rendering form fields from TCEforms. See TCEforms for details on this. Includes for instance the value and the form field name, java script actions and more.
	array	"special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
	array	Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
	string	Record "type" field value.
	string	Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
	integer	PID value of record (true parent page id)

Rückgabe:

string HTML code for RTE!

t3lib_rteapi::isAvailable

(

)

Returns true if the RTE is available. Here you check if the browser requirements are met. If there are reasons why the RTE cannot be displayed you simply enter them as text in ->errorLog

Rückgabe:

boolean TRUE if this RTE object offers an RTE in the current browser environment

t3lib_rteapi::transformContent	(	$	dirRTE,
		$	value,
		$	table,
		$	field,
		$	row,
		$	specConf,
		$	thisConfig,
		$	RTErelPath,
		$	pid
	)

Performs transformation of content to/from RTE. The keyword $dirRTE determines the direction. This function is called in two situations: a) Right before content from database is sent to the RTE (see ->drawRTE()) it might need transformation b) When content is sent from the RTE and into the database it might need transformation back again (going on in TCEmain class; You can't affect that.)

Parameter:

	string	Keyword: "rte" means direction from db to rte, "db" means direction from Rte to DB
	string	Value to transform.
	string	The table name
	string	The field name
	array	The current row from which field is being rendered
	array	"special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
	array	Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
	string	Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
	integer	PID value of record (true parent page id)

Rückgabe:

string Transformed content

t3lib_rteapi::triggerField

(

$

fieldName

)

Trigger field - this field tells the TCEmain that processing should be done on this value!

Parameter:

string

Field name of the RTE field.

Rückgabe:

string <input> field of type "hidden" with a flag telling the TCEmain that this fields content should be traansformed back to database state.

---

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

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_rteapi.php