"TYPO3 4.0.1: tx_rtehtmlarea_base Class Reference", "datetime" => "Sat Dec 2 19:27:20 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

tx_rtehtmlarea_base Class Reference

Inheritance diagram for tx_rtehtmlarea_base:

Inheritance graph
[legend]
Collaboration diagram for tx_rtehtmlarea_base:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 isAvailable ()
 drawRTE (&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue)
 setToolBar ()
 setPlugins ()
 convertToolBarForHTMLArea ($button)
 setRTEsizeByJS ($divId, $height, $width)
 loadJSfiles ($number)
 loadJScode ($number)
 registerRTEinJS ($number)
 isPluginEnable ($plugin)
 buildJSFontSizesConfig ($number)
 buildJSParagraphsConfig ($number)
 buildJSFontfacesConfig ($number)
 buildJSColorsConfig ($number)
 buildStyleSheet ()
 buildJSClassesConfig ($number)
 buildJSClassesArray ()
 buildJSMainLangArray ()
 buildJSAcronymArray ()
 buildJSClassesAnchorConfig ($number)
 buildJSClassesAnchorArray ()
 buildJSFile ($label, $contents, $ext='js')
 writeJSFileToTypo3tempDir ($JSFile, $label, $compressed=FALSE, $ext='js')
 buildJSMainLangFile ($number)
 buildJSLangArray ($plugin)
 getJSToolbarArray ()
 getLLContent ($string)
 feJScharCode ($str)
 getFullFileName ($filename)
 setSaveRTE ($number, $form, $textarea)
 clientInfo ($useragent='')
 RTEtsConfigParams ()
 cleanList ($str)
 filterStyleEl ($elValue, $matchList)
 loremIpsumInsert ($params)

Public Attributes

 $conf_supported_browser
 $conf_toolbar_hide
 $conf_toolbar_safari_hide
 $conf_toolbar_opera_hide
 $conf_toolbar_show
 $defaultToolbarOrder
 $defaultHotKeyList = 'selectall, bold, italic, underline, strikethrough, left, center, right, justifyfull, formatblock, paste, cleanword, undo, redo'
 $conf_toolbar_convert
 $defaultParagraphs
 $defaultFontFaces
 $defaultFontSizes
 $defaultFontSizes_safari
 $pluginList = 'TableOperations, ContextMenu, SpellChecker, SelectColor, TYPO3Browsers, InsertSmiley, FindReplace, RemoveFormat, CharacterMap, QuickTag, InlineCSS, DynamicCSS, UserElements, Acronym, TYPO3HtmlParser'
 $pluginButton
 $pluginLabel
 $spellCheckerModes = array( 'ultra', 'fast', 'normal', 'bad-spellers')
 $RTEdivStyle
 $extHttpPath
 $siteURL
 $hostURL
 $typoVersion
 $ID = 'rtehtmlarea'
 $debugMode = FALSE
 $client
 $TCEform
 $elementId
 $elementParts
 $tscPID
 $typeVal
 $thePid
 $RTEsetup
 $thisConfig
 $confValues
 $language
 $BECharset
 $OutputCharset
 $editorCSS
 $spellCheckerLanguage
 $spellCheckerCharset
 $spellCheckerMode
 $quickTagHideTags
 $specConf
 $toolBar = array()
 $toolbar_level_size
 $toolbarOrderArray = array()
 $pluginEnableList
 $pluginEnableArray = array()

Detailed Description

A RTE using the htmlArea editor

Author:
Philipp Borgmann <philipp.borgmann@gmx.de>

Stanislas Rolland <stanislas.rolland(arobas)fructifor.ca>

Id
class.tx_rtehtmlarea_base.php 1342 2006-03-20 01:08:38Z stanrolland
*

Definition at line 41 of file class.tx_rtehtmlarea_base.php.

Member Function Documentation

tx_rtehtmlarea_base::buildJSAcronymArray (   ) 
 

Return an acronym array for the Acronym plugin

Returns:
string acronym array

Definition at line 1431 of file class.tx_rtehtmlarea_base.php.

References t3lib_BEfunc::BEenableFields(), and t3lib_BEfunc::deleteClause().

tx_rtehtmlarea_base::buildJSClassesAnchorArray (   ) 
 

Return a JS array for special anchor classes

Returns:
string classesAnchor array definition

Definition at line 1485 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::buildJSClassesAnchorConfig (  $  number  ) 
 

Return JS configuration of special anchor classes

Returns:
string JS special anchor classes configuration

Definition at line 1463 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::buildJSClassesArray (   ) 
 

Return JS arrays of classes labels and noShow flags

Returns:
string JS classes arrays

Definition at line 1330 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::buildJSClassesConfig (  $  number  ) 
 

Return JS configuration of classes

Returns:
string JS classes configuration

Definition at line 1304 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::trimExplode().

tx_rtehtmlarea_base::buildJSColorsConfig (  $  number  ) 
 

Return JS configuration of colors

Returns:
string JS colors configuration

Definition at line 1192 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::trimExplode().

tx_rtehtmlarea_base::buildJSFile (  $  label,
$  contents,
$  ext = 'js'
) 
 

Return a file name built with the label and containing the specified contents

Returns:
string filename

Definition at line 1524 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::fixPermissions().

tx_rtehtmlarea_base::buildJSFontfacesConfig (  $  number  ) 
 

Return JS configuration of font faces

Returns:
string JS font faces configuration

Definition at line 1114 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::inList(), and t3lib_div::trimExplode().

tx_rtehtmlarea_base::buildJSFontSizesConfig (  $  number  ) 
 

Return JS configuration of font sizes

Returns:
string JS font sizes configuration

Definition at line 1014 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::trimExplode().

tx_rtehtmlarea_base::buildJSLangArray (  $  plugin  ) 
 

Return a JS language array for the plugin

Returns:
string JS language array

Definition at line 1578 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::array_merge_recursive_overrule(), and t3lib_extMgm::extPath().

tx_rtehtmlarea_base::buildJSMainLangArray (   ) 
 

Return a JS language array for htmlArea RTE

Returns:
string JS language array

Definition at line 1376 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::buildJSMainLangFile (  $  number  ) 
 

Return a file name containing the main JS language array for HTMLArea

Returns:
string filename

Definition at line 1561 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::trimExplode().

tx_rtehtmlarea_base::buildJSParagraphsConfig (  $  number  ) 
 

Return JS configuration of paragraphs

Returns:
string JS paragraphs configuration

Definition at line 1073 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::trimExplode().

tx_rtehtmlarea_base::buildStyleSheet (   ) 
 

Build the default content style sheet

Returns:
string Style sheet

Definition at line 1255 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::clientInfo (  $  useragent = ''  ) 
 

Client Browser Information

Usage: 4

Parameters:
string Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)
Returns:
array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE

Definition at line 1750 of file class.tx_rtehtmlarea_base.php.

Referenced by tx_rtehtmlarea_pi2::drawRTE(), drawRTE(), and isAvailable().

tx_rtehtmlarea_base::convertToolBarForHTMLArea (  $  button  ) 
 

Convert the TYPO3 names of buttons into the names for htmlArea RTE

Parameters:
string buttonname (typo3-name)
Returns:
string buttonname (htmlarea-name)

Definition at line 798 of file class.tx_rtehtmlarea_base.php.

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

Draws the RTE as an iframe

Parameters:
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)
Returns:
string HTML code for RTE!

Reimplemented from t3lib_rteapi.

Reimplemented in tx_rtehtmlarea_pi2.

Definition at line 354 of file class.tx_rtehtmlarea_base.php.

References $specConf, $thisConfig, t3lib_BEfunc::BEenableFields(), clientInfo(), t3lib_BEfunc::deleteClause(), t3lib_div::getIndpEnv(), t3lib_BEfunc::getPagesTSconfig(), t3lib_BEfunc::getTSCpid(), t3lib_div::int_from_ver(), t3lib_extMgm::isLoaded(), isPluginEnable(), loadJScode(), loadJSfiles(), registerRTEinJS(), setPlugins(), setRTEsizeByJS(), setSaveRTE(), setToolBar(), t3lib_extMgm::siteRelPath(), t3lib_rteapi::transformContent(), t3lib_rteapi::triggerField(), and t3lib_div::trimExplode().

tx_rtehtmlarea_base::getJSToolbarArray (   ) 
 

Return the JS-Code for the Toolbar-Config-Array for HTML-Area

Returns:
string the JS-Code as an JS-Array

Definition at line 1626 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::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

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

Reimplemented from t3lib_rteapi.

Definition at line 296 of file class.tx_rtehtmlarea_base.php.

References clientInfo(), and t3lib_div::int_from_ver().

tx_rtehtmlarea_base::isPluginEnable (  $  plugin  ) 
 

Return ture, if the plugin can loaded

Returns:
boolean 1 if the plugin can be loaded

Definition at line 1004 of file class.tx_rtehtmlarea_base.php.

Referenced by tx_rtehtmlarea_pi2::drawRTE(), drawRTE(), loadJScode(), setPlugins(), and setToolBar().

tx_rtehtmlarea_base::loadJScode (  $  number  ) 
 

Return the JS-Code to initialize the Editor

Returns:
string the html-code for loading the Javascript-Files

Definition at line 859 of file class.tx_rtehtmlarea_base.php.

References isPluginEnable(), and t3lib_div::trimExplode().

Referenced by tx_rtehtmlarea_pi2::drawRTE(), and drawRTE().

tx_rtehtmlarea_base::loadJSfiles (  $  number  ) 
 

Return the HTML-Code for loading the Javascript-Files

Returns:
string the html-code for loading the Javascript-Files

Definition at line 821 of file class.tx_rtehtmlarea_base.php.

Referenced by tx_rtehtmlarea_pi2::drawRTE(), and drawRTE().

tx_rtehtmlarea_base::registerRTEinJS (  $  number  ) 
 

Return the JS-Code for Register the RTE in JS

Returns:
string the JS-Code for Register the RTE in JS

Definition at line 890 of file class.tx_rtehtmlarea_base.php.

Referenced by tx_rtehtmlarea_pi2::drawRTE(), and drawRTE().

tx_rtehtmlarea_base::RTEtsConfigParams (   ) 
 

Returns:
[type] ...

Definition at line 1826 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::setPlugins (   ) 
 

Disable some plugins

Definition at line 752 of file class.tx_rtehtmlarea_base.php.

References t3lib_extMgm::isLoaded(), isPluginEnable(), and t3lib_div::trimExplode().

Referenced by tx_rtehtmlarea_pi2::drawRTE(), and drawRTE().

tx_rtehtmlarea_base::setRTEsizeByJS (  $  divId,
$  height,
$  width
) 
 

Return the JS-function for setting the RTE size.

Parameters:
string DivID-Name
int the height for the RTE
int the width for the RTE
Returns:
string Loader function in JS

Definition at line 810 of file class.tx_rtehtmlarea_base.php.

Referenced by drawRTE().

tx_rtehtmlarea_base::setSaveRTE (  $  number,
$  form,
$  textarea
) 
 

Return the JS-Code to copy the HTML-Code from the editor in the hidden input field. This is for submit function from the form.

Returns:
string the JS-Code

Reimplemented in tx_rtehtmlarea_pi2.

Definition at line 1729 of file class.tx_rtehtmlarea_base.php.

Referenced by drawRTE().

tx_rtehtmlarea_base::setToolBar (   ) 
 

Set the toolbar config (only in this PHP-Object, not in JS):

Definition at line 626 of file class.tx_rtehtmlarea_base.php.

References isPluginEnable(), and t3lib_div::trimExplode().

Referenced by tx_rtehtmlarea_pi2::drawRTE(), and drawRTE().

tx_rtehtmlarea_base::writeJSFileToTypo3tempDir (  $  JSFile,
$  label,
$  compressed = FALSE,
$  ext = 'js'
) 
 

Return a file name built with the label and containing a cached copy of the specified file

Returns:
string filename

Definition at line 1542 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::fixPermissions(), and t3lib_div::getFileAbsFileName().

Member Data Documentation

tx_rtehtmlarea_base::$conf_supported_browser
 

Initial value:

 array (
                        'msie' => array (
                                1 => array (
                                        'version' => 5.5,
                                        'system' => 'win'
                                )
                        ),
                        'gecko' => array (
                                1 => array (
                                        'version' => 1.3
                                )
                        ),
                        'safari' => array (
                                1 => array (
                                        'version' => 312
                                )
                        ),
                        'opera' => array (
                                1 => array (
                                        'version' => 9,
                                        'system' => 'win'
                                )
                        )
                )

Definition at line 44 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$conf_toolbar_hide
 

Initial value:

 array (
                'showhelp',             // Has no content yet
                )

Definition at line 70 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$conf_toolbar_opera_hide
 

Initial value:

 array (
                'textstyle',
                'blockstyle',
                'copy',
                'cut',
                'paste',
                )

Definition at line 83 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$conf_toolbar_safari_hide
 

Initial value:

 array (
                'strikethrough',
                'line',
                'orderedlist',
                'unorderedlist',
                )

Definition at line 75 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$conf_toolbar_show
 

Initial value:

 array (
                'undo',
                'redo',
                //'showhelp',
                'about',
                )

Definition at line 92 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$defaultFontFaces
 

Initial value:

 array(
                'Arial'                 => 'Arial,sans-serif',
                'Arial Black'           => 'Arial Black,sans-serif',
                'Verdana'               => 'Verdana,Arial,sans-serif',
                'Times New Roman'       => 'Times New Roman,Times,serif',
                'Garamond'              => 'Garamond',
                'Lucida Handwriting'    => 'Lucida Handwriting',
                'Courier'               => 'Courier',
                'Webdings'              => 'Webdings',
                'Wingdings'             => 'Wingdings',
                )

Definition at line 195 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$defaultFontSizes
 

Initial value:

 array(
                '1'     =>      '1 (8 pt)',
                '2'     =>      '2 (10 pt)',
                '3'     =>      '3 (12 pt)',
                '4'     =>      '4 (14 pt)',
                '5'     =>      '5 (18 pt)',
                '6'     =>      '6 (24 pt)',
                '7'     =>      '7 (36 pt)',
                )

Definition at line 207 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$defaultFontSizes_safari
 

Initial value:

 array(
                '1'     =>      'xx-small',
                '2'     =>      'x-small',
                '3'     =>      'small',
                '4'     =>      'medium',
                '5'     =>      'large',
                '6'     =>      'x-large',
                '7'     =>      'xx-large',
                )

Definition at line 217 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$defaultParagraphs
 

Initial value:

 array(
                'p'             => 'Normal',
                'h1'            => 'Heading 1',
                'h2'            => 'Heading 2',
                'h3'            => 'Heading 3',
                'h4'            => 'Heading 4',
                'h5'            => 'Heading 5',
                'h6'            => 'Heading 6',
                'pre'           => 'Preformatted',
                'address'       => 'Address',
                )

Definition at line 183 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$pluginButton
 

Initial value:

 array(
                'InlineCSS'             => 'textstyle',
                'DynamicCSS'            => 'blockstyle',
                'SpellChecker'          => 'spellcheck',
                'InsertSmiley'          => 'emoticon',
                'FindReplace'           => 'findreplace',
                'RemoveFormat'          => 'removeformat',
                'QuickTag'              => 'inserttag',
                'CharacterMap'          => 'insertcharacter',
                'TableOperations'       => 'table, toggleborders, tableproperties, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit,
                                                columninsertbefore, columninsertafter, columndelete, columnsplit,
                                                cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge',
                'UserElements'          => 'user',
                'Acronym'               => 'acronym',
                )

Definition at line 229 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$pluginLabel
 

Initial value:

 array(
                'InlineCSS'     => 'textstylelabel',
                'DynamicCSS'    => 'blockstylelabel',
                )

Definition at line 245 of file class.tx_rtehtmlarea_base.php.

The documentation for this class was generated from the following file: