tx_rtehtmlarea_base Class Reference

Inheritance diagram for tx_rtehtmlarea_base:

[legend]Collaboration diagram for tx_rtehtmlarea_base:


Public Member Functions
	isAvailable ()
	drawRTE ($parentObject, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue)
	enableRegisteredPlugins ()
	setToolbar ()
	setPlugins ()
	convertToolbarForHTMLArea ($button)
	setRTEsizeByJS ($divId, $height, $width)
	loadJSfiles ($RTEcounter)
	loadJScode ($RTEcounter)
	registerRTEinJS ($RTEcounter, $table='', $uid='', $field='', $textAreaId= '')
	isPluginEnabled ($pluginId)
	buildStyleSheet ()
	buildJSClassesConfig ($RTEcounter)
	buildJSClassesArray ()
	buildNestedJSArray ($conf)
	buildJSMainLangArray ()
	writeTemporaryFile ($sourceFileName='', $label, $fileExtension='js', $contents='')
	buildJSMainLangFile ($RTEcounter)
	buildJSLangArray ($plugin)
	getJSToolbarArray ()
	getLLContent ($string)
	getPageConfigLabel ($string, $JScharCode=1)
	feJScharCode ($str)
	getFullFileName ($filename)
	setSaveRTE ($RTEcounter, $formName, $textareaId)
	setDeleteRTE ($RTEcounter, $formName, $textareaId)
	is_FE ()
	clientInfo ($useragent='')
	RTEtsConfigParams ()
	cleanList ($str)
	filterStyleEl ($elValue, $matchList)
	loremIpsumInsert ($params)
Public Attributes
	$conf_supported_browser
	$conf_toolbar_hide
	$conf_toolbar_show
	$defaultToolbarOrder
	$convertToolbarForHtmlAreaArray
	$pluginButton = array()
	$pluginLabel = array()
	$RTEdivStyle
	$httpTypo3Path
	$extHttpPath
	$siteURL
	$hostURL
	$typoVersion
	$ID = 'rtehtmlarea'
	$debugMode = FALSE
	$client
	$TCEform
	$elementId
	$elementParts
	$tscPID
	$typeVal
	$thePid
	$RTEsetup
	$thisConfig
	$confValues
	$language
	$contentTypo3Language
	$contentISOLanguage
	$contentCharset
	$OutputCharset
	$editorCSS
	$specConf
	$toolbar = array()
	$toolbar_level_size
	$toolbarOrderArray = array()
	$registeredPlugins = array()
Protected Member Functions
	addPageStyle ()
	addSkin ()
	addStyleSheet ($key, $href, $title='', $relation='stylesheet')
	initializeToolbarConfiguration ()
Protected Attributes
	$pluginEnabledArray = array()
	$pluginEnabledCumulativeArray = array()

Detailed Description

A RTE using the htmlArea editor

Author:: Philipp Borgmann <philipp.borgmann@gmx.de>
Stanislas Rolland <typo3(arobas)sjbr.ca>

Id: class.tx_rtehtmlarea_base.php 4556 2008-12-18 04:29:32Z stan

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

Member Function Documentation

tx_rtehtmlarea_base::addPageStyle ( ) [protected]

Add link to content style sheet to document header

Returns:: void

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

References addStyleSheet(), and getFullFileName().

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

tx_rtehtmlarea_base::addSkin ( ) [protected]

Add links to skin style sheet(s) to document header

Returns:: void

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

References addStyleSheet(), t3lib_extMgm::isLoaded(), and t3lib_extMgm::siteRelPath().

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

tx_rtehtmlarea_base::addStyleSheet	(	$	key,
		$	href,
		$	title = `''`,
		$	relation = `'stylesheet'`
	)			`[protected]`

Add style sheet file to document header

Parameters:

	string	$key: some key identifying the style sheet
	string	$href: uri to the style sheet file
	string	$title: value for the title attribute of the link element

Returns:: string $relation: value for the rel attribute of the link element
void

Reimplemented in tx_rtehtmlarea_pi2.

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

References $key.

Referenced by addPageStyle(), and addSkin().

tx_rtehtmlarea_base::buildJSClassesArray ( )

Return JS arrays of classes labels and noShow flags

Returns:: string JS classes arrays

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

Referenced by buildJSClassesConfig().

tx_rtehtmlarea_base::buildJSClassesConfig ( $ RTEcounter )

Return Javascript configuration of classes

Parameters:

integer

$RTEcounter: The index number of the current RTE editing area within the form.

Returns:: string Javascript configuration of classes

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

References buildJSClassesArray(), cleanList(), t3lib_div::trimExplode(), and writeTemporaryFile().

Referenced by registerRTEinJS().

tx_rtehtmlarea_base::buildJSLangArray ( $ plugin )

Return a Javascript localization array for the plugin

Parameters:

string

$plugin: identification string of the plugin

Returns:: string Javascript localization array

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

References $LOCAL_LANG, t3lib_div::array_merge_recursive_overrule(), t3lib_extMgm::extPath(), is_FE(), and t3lib_div::readLLfile().

Referenced by buildJSMainLangFile().

tx_rtehtmlarea_base::buildJSMainLangArray ( )

Return a Javascript localization array for htmlArea RTE

Returns:: string Javascript localization array

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

References $LOCAL_LANG, $TSFE, t3lib_div::array_merge_recursive_overrule(), t3lib_extMgm::extPath(), is_FE(), and t3lib_div::readLLfile().

Referenced by buildJSMainLangFile().

tx_rtehtmlarea_base::buildJSMainLangFile ( $ RTEcounter )

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

Parameters:

integer

$RTEcounter: The index number of the current RTE editing area within the form.

Returns:: string filename

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

References buildJSLangArray(), buildJSMainLangArray(), and writeTemporaryFile().

tx_rtehtmlarea_base::buildNestedJSArray ( $ conf )

Translate Page TS Config array in JS nested array definition

Parameters:

array

$conf: Page TSConfig configuration array

Returns:: string nested JS array definition

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

Referenced by registerRTEinJS().

tx_rtehtmlarea_base::buildStyleSheet ( )

Build the default content style sheet

Returns:: string Style sheet

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

tx_rtehtmlarea_base::cleanList ( $ str )

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

References t3lib_div::trimExplode().

Referenced by buildJSClassesConfig().

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 1522 of file class.tx_rtehtmlarea_base.php.

References t3lib_div::getIndpEnv().

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 752 of file class.tx_rtehtmlarea_base.php.

Referenced by getJSToolbarArray().

tx_rtehtmlarea_base::drawRTE	(	$	parentObject,
		$	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 in tx_rtehtmlarea_pi2.

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

References $res, $row, $specConf, $thisConfig, $TYPO3_CONF_VARS, $TYPO3_DB, $value, addPageStyle(), addSkin(), t3lib_BEfunc::BEenableFields(), clientInfo(), t3lib_BEfunc::deleteClause(), t3lib_div::getIndpEnv(), t3lib_BEfunc::getPagesTSconfig(), t3lib_BEfunc::getTSCpid(), initializeToolbarConfiguration(), t3lib_div::int_from_ver(), t3lib_extMgm::isLoaded(), isPluginEnabled(), loadJScode(), loadJSfiles(), registerRTEinJS(), setDeleteRTE(), setRTEsizeByJS(), setSaveRTE(), t3lib_extMgm::siteRelPath(), t3lib_rteapi::transformContent(), and t3lib_rteapi::triggerField().

tx_rtehtmlarea_base::enableRegisteredPlugins ( )

Add registered plugins to the array of enabled plugins

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

References $TYPO3_CONF_VARS, t3lib_div::getUserObj(), and t3lib_div::trimExplode().

Referenced by initializeToolbarConfiguration().

tx_rtehtmlarea_base::feJScharCode ( $ str )

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

References $TSFE.

tx_rtehtmlarea_base::filterStyleEl	(	$	elValue,
		$	matchList
	)

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

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

tx_rtehtmlarea_base::getFullFileName ( $ filename )

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

References t3lib_extMgm::isLoaded(), and t3lib_extMgm::siteRelPath().

Referenced by addPageStyle().

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 1358 of file class.tx_rtehtmlarea_base.php.

References $toolbar, and convertToolbarForHTMLArea().

Referenced by registerRTEinJS().

tx_rtehtmlarea_base::getLLContent ( $ string )

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

tx_rtehtmlarea_base::getPageConfigLabel	(	$	string,
		$	JScharCode = `1`
	)

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

tx_rtehtmlarea_base::initializeToolbarConfiguration ( ) [protected]

Initialize toolbar configuration and enable registered plugins

Returns:: void

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

References enableRegisteredPlugins(), setPlugins(), and setToolbar().

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

tx_rtehtmlarea_base::is_FE ( )

Return true if we are in the FE, but not in the FE editing feature of BE.

Returns:: boolean

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

References $TSFE.

Referenced by buildJSLangArray(), buildJSMainLangArray(), loadJScode(), registerRTEinJS(), and RTEtsConfigParams().

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 148 of file class.tx_rtehtmlarea_base.php.

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

tx_rtehtmlarea_base::isPluginEnabled ( $ pluginId )

Return true, if the plugin can be loaded

Parameters:

string

$pluginId: The identification string of the plugin

Returns:: boolean true if the plugin can be loaded

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

Referenced by tx_rtehtmlarea_pi2::drawRTE(), drawRTE(), registerRTEinJS(), setPlugins(), and setToolbar().

tx_rtehtmlarea_base::loadJScode ( $ RTEcounter )

Return the Javascript code for initializing the RTE

Parameters:

integer

$RTEcounter: The index number of the current RTE editing area within the form.

Returns:: string the Javascript code for initializing the RTE

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

References is_FE().

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

tx_rtehtmlarea_base::loadJSfiles ( $ RTEcounter )

Return the HTML code for loading the Javascript files

Parameters:

integer

$RTEcounter: The index number of the current RTE editing area within the form.

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

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

References $TYPO3_CONF_VARS.

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

tx_rtehtmlarea_base::loremIpsumInsert ( $ params )

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

tx_rtehtmlarea_base::registerRTEinJS	(	$	RTEcounter,
		$	table = `''`,
		$	uid = `''`,
		$	field = `''`,
		$	textAreaId = `''`
	)

Return the Javascript code for configuring the RTE

Parameters:

	integer	$RTEcounter: The index number of the current RTE editing area within the form.
	string	$table: The table that includes this RTE (optional, necessary for IRRE).
	string	$uid: The uid of that table that includes this RTE (optional, necessary for IRRE).
	string	$field: The field of that record that includes this RTE (optional).

Returns:: string the Javascript code for configuring the RTE

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

References buildJSClassesConfig(), buildNestedJSArray(), getJSToolbarArray(), is_FE(), isPluginEnabled(), and t3lib_div::trimExplode().

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

tx_rtehtmlarea_base::RTEtsConfigParams ( )

Returns:: [type] ...

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

References t3lib_BEfunc::getSpecConfParametersFromArray(), and is_FE().

tx_rtehtmlarea_base::setDeleteRTE	(	$	RTEcounter,
		$	formName,
		$	textareaId
	)

Return the Javascript code for copying the HTML code from the editor into the hidden input field. This is for submit function of the form.

Parameters:

	integer	$RTEcounter: The index number of the current RTE editing area within the form.
	string	$formName: the name of the form
	string	$textareaId: the id of the textarea

Returns:: string Javascript code

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

Referenced by drawRTE().

tx_rtehtmlarea_base::setPlugins ( )

Disable some plugins

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

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

Referenced by initializeToolbarConfiguration().

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 764 of file class.tx_rtehtmlarea_base.php.

Referenced by drawRTE().

tx_rtehtmlarea_base::setSaveRTE	(	$	RTEcounter,
		$	formName,
		$	textareaId
	)

Return the Javascript code for copying the HTML code from the editor into the hidden input field. This is for submit function of the form.

Parameters:

	integer	$RTEcounter: The index number of the current RTE editing area within the form.
	string	$formName: the name of the form
	string	$textareaId: the id of the textarea

Returns:: string Javascript code

Reimplemented in tx_rtehtmlarea_pi2.

Definition at line 1484 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 568 of file class.tx_rtehtmlarea_base.php.

References $value, t3lib_div::inList(), isPluginEnabled(), and t3lib_div::trimExplode().

Referenced by initializeToolbarConfiguration().

tx_rtehtmlarea_base::writeTemporaryFile	(	$	sourceFileName = `''`,
		$	label,
		$	fileExtension = `'js'`,
		$	contents = `''`
	)

Writes contents in a file in typo3temp/rtehtmlarea directory and returns the file name

Parameters:

	string	$sourceFileName: The name of the file from which the contents should be extracted
	string	$label: A label to insert at the beginning of the name of the file
	string	$fileExtension: The file extension of the file, defaulting to 'js'
	string	contents The contents to write into the file if no sourceFileName is provided

Returns:: string The name of the file writtten to typo3temp/rtehtmlarea

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

References t3lib_div::getFileAbsFileName(), t3lib_div::minifyJavaScript(), t3lib_div::shortMD5(), and t3lib_div::writeFileToTypo3tempDir().

Referenced by buildJSClassesConfig(), and buildJSMainLangFile().

Member Data Documentation

tx_rtehtmlarea_base::$client

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

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' => 523
                )
            ),
            'opera' => array (
                1 => array (
                    'version' => 9.5
                )
            )
        )

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 69 of file class.tx_rtehtmlarea_base.php.

tx_rtehtmlarea_base::$conf_toolbar_show

Initial value:

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

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

tx_rtehtmlarea_base::$confValues

Reimplemented in tx_rtehtmlarea_pi2.

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

tx_rtehtmlarea_base::$contentCharset

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

tx_rtehtmlarea_base::$contentISOLanguage

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

tx_rtehtmlarea_base::$contentTypo3Language

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

tx_rtehtmlarea_base::$convertToolbarForHtmlAreaArray

Initial value:

 array (
        'line'          => 'InsertHorizontalRule',
        'chMode'        => 'HtmlMode',
        'showhelp'      => 'ShowHelp',
        'textindicator'     => 'TextIndicator',
        'space'         => 'space',
        'bar'           => 'separator',
        'linebreak'     => 'linebreak',
        )

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

tx_rtehtmlarea_base::$debugMode = FALSE

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

tx_rtehtmlarea_base::$defaultToolbarOrder

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

tx_rtehtmlarea_base::$editorCSS

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

tx_rtehtmlarea_base::$elementId

Reimplemented in tx_rtehtmlarea_pi2.

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

tx_rtehtmlarea_base::$elementParts

Reimplemented in tx_rtehtmlarea_pi2.