<?php
include_once '../doc-typo3-funcs.php';
$doxygen_vars = array( "title" => "TYPO3 4.0.1: t3lib_rteapi Class Reference",
"datetime" => "Sat Dec 2 19:26:08 2006",
"date" => "2 Dec 2006",
"doxygenversion" => "1.4.6",
"projectname" => "TYPO3 4.0.1",
"projectnumber" => "4.0.1"
);
get_header($doxygen_vars);
?>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<h1>t3lib_rteapi Class Reference</h1><!-- doxytag: class="t3lib_rteapi" -->Inheritance diagram for t3lib_rteapi:<p><center><img src="classt3lib__rteapi__inherit__graph.png" border="0" usemap="#t3lib__rteapi__inherit__map" alt="Inheritance graph"></center>
<map name="t3lib__rteapi__inherit__map">
<area href="classtx__rtehtmlarea__base.html" shape="rect" coords="5,191,216,1439" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classt3lib__rteapi-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__rteapi.html#167fea45c54ff1a77f38dc145a2ad87b">isAvailable</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__rteapi.html#60ab0e6eeeaea2f8b04cf31e1d26ee94">drawRTE</a> (&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__rteapi.html#490ab53a197b928b308871d10a4adbb7">transformContent</a> ($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__rteapi.html#eda90a0e49f9435041d60ed28896a801">triggerField</a> ($fieldName)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09c04b29443422519e7ae8825111ae7e"></a><!-- doxytag: member="t3lib_rteapi::$errorLog" ref="09c04b29443422519e7ae8825111ae7e" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__rteapi.html#09c04b29443422519e7ae8825111ae7e">$errorLog</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09735e339915f746c7194fa62ea66957"></a><!-- doxytag: member="t3lib_rteapi::$ID" ref="09735e339915f746c7194fa62ea66957" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__rteapi.html#09735e339915f746c7194fa62ea66957">$ID</a> = ''</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00064">64</a> of file <a class="el" href="class_8t3lib__rteapi_8php-source.html">class.t3lib_rteapi.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="60ab0e6eeeaea2f8b04cf31e1d26ee94"></a><!-- doxytag: member="t3lib_rteapi::drawRTE" ref="60ab0e6eeeaea2f8b04cf31e1d26ee94" args="(&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_rteapi::drawRTE </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">&$ </td>
<td class="mdname" nowrap> <em>pObj</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>table</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>field</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>row</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>PA</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>specConf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>thisConfig</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>RTEtypeVal</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>RTErelPath</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>thePidValue</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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!<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Reference to parent object, which is an instance of the TCEforms. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>The table name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>The field name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>The current row from which field is being rendered </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>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. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>"special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Record "type" field value. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>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! </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>PID value of record (true parent page id) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string HTML code for RTE! </dd></dl>
<p>
Reimplemented in <a class="el" href="classtx__rtehtmlarea__base.html#9242f6e6b6291bb4836555ec1ab1b8b1">tx_rtehtmlarea_base</a>, and <a class="el" href="classtx__rtehtmlarea__pi2.html#c8f128cbdc7b512aed074e3f6ff343af">tx_rtehtmlarea_pi2</a>.
<p>
Definition at line <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00118">118</a> of file <a class="el" href="class_8t3lib__rteapi_8php-source.html">class.t3lib_rteapi.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l01365">t3lib_div::formatForTextarea()</a>, and <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00151">transformContent()</a>. </td>
</tr>
</table>
<a class="anchor" name="167fea45c54ff1a77f38dc145a2ad87b"></a><!-- doxytag: member="t3lib_rteapi::isAvailable" ref="167fea45c54ff1a77f38dc145a2ad87b" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_rteapi::isAvailable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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<p>
<dl compact><dt><b>Returns:</b></dt><dd>boolean TRUE if this RTE object offers an RTE in the current browser environment </dd></dl>
<p>
Reimplemented in <a class="el" href="classtx__rtehtmlarea__base.html#9ff6c40452f081ae763499673b64b855">tx_rtehtmlarea_base</a>.
<p>
Definition at line <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00093">93</a> of file <a class="el" href="class_8t3lib__rteapi_8php-source.html">class.t3lib_rteapi.php</a>. </td>
</tr>
</table>
<a class="anchor" name="490ab53a197b928b308871d10a4adbb7"></a><!-- doxytag: member="t3lib_rteapi::transformContent" ref="490ab53a197b928b308871d10a4adbb7" args="($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_rteapi::transformContent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>dirRTE</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>value</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>table</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>field</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>row</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>specConf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>thisConfig</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>RTErelPath</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>pid</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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 -><a class="el" href="classt3lib__rteapi.html#60ab0e6eeeaea2f8b04cf31e1d26ee94">drawRTE()</a>) 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.)<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Keyword: "rte" means direction from db to rte, "db" means direction from Rte to <a class="el" href="classDB.html">DB</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Value to transform. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>The table name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>The field name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>The current row from which field is being rendered </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>"special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>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! </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>PID value of record (true parent page id) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string Transformed content </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00151">151</a> of file <a class="el" href="class_8t3lib__rteapi_8php-source.html">class.t3lib_rteapi.php</a>.
<p>
References <a class="el" href="class_8t3lib__befunc_8php-source.html#l00941">t3lib_BEfunc::getSpecConfParametersFromArray()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>.
<p>
Referenced by <a class="el" href="class_8tx__rtehtmlarea__pi2_8php-source.html#l00075">tx_rtehtmlarea_pi2::drawRTE()</a>, <a class="el" href="class_8tx__rtehtmlarea__base_8php-source.html#l00354">tx_rtehtmlarea_base::drawRTE()</a>, and <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00118">drawRTE()</a>. </td>
</tr>
</table>
<a class="anchor" name="eda90a0e49f9435041d60ed28896a801"></a><!-- doxytag: member="t3lib_rteapi::triggerField" ref="eda90a0e49f9435041d60ed28896a801" args="($fieldName)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_rteapi::triggerField </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>fieldName</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Trigger field - this field tells the TCEmain that processing should be done on this value!<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Field name of the RTE field. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string <input> field of type "hidden" with a flag telling the TCEmain that this fields content should be traansformed back to database state. </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__rteapi_8php-source.html#l00197">197</a> of file <a class="el" href="class_8t3lib__rteapi_8php-source.html">class.t3lib_rteapi.php</a>.
<p>
Referenced by <a class="el" href="class_8tx__rtehtmlarea__pi2_8php-source.html#l00075">tx_rtehtmlarea_pi2::drawRTE()</a>, and <a class="el" href="class_8tx__rtehtmlarea__base_8php-source.html#l00354">tx_rtehtmlarea_base::drawRTE()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>typo3_src-4.0.1/t3lib/<a class="el" href="class_8t3lib__rteapi_8php-source.html">class.t3lib_rteapi.php</a></ul>
<?php
include_once '../doc-typo3-funcs.php';
get_footer();
?>