Solutions Open Source

Référence de la classe t3lib_rteapi

Graphe d'héritage de t3lib_rteapi:

Inheritance graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 isAvailable ()
 drawRTE (&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue)
 transformContent ($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid)
 triggerField ($fieldName)

Attributs publics

 $errorLog = array()
 $ID = ''


Documentation des fonctions membres

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

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

Réimplémentée dans tx_rtehtmlarea_base.

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!

Paramètres:
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)
Renvoie:
string HTML code for RTE!

Réimplémentée dans tx_rtehtmlarea_base, et tx_rtehtmlarea_pi2.

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

Paramètres:
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)
Renvoie:
string Transformed content

t3lib_rteapi::triggerField ( fieldName  ) 

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

Paramètres:
string Field name of the RTE field.
Renvoie:
string <input> field of type "hidden" with a flag telling the TCEmain that this fields content should be traansformed back to database state.


Documentation des données membres

t3lib_rteapi::$errorLog = array()

t3lib_rteapi::$ID = ''

Réimplémentée dans tx_rtehtmlarea_base.


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:42:30 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3