Solutions Open Source

Référence de la classe tx_rtehtmlarea_base

Graphe d'héritage de tx_rtehtmlarea_base:

[légende]

Graphe de collaboration de tx_rtehtmlarea_base:

[légende]

Liste de tous les membres

Fonctions membres publiques

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, $table='', $uid='', $field='')

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)

Attributs publics

$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()

Description détaillée

A RTE using the htmlArea editor

Auteur:: Philipp Borgmann <philipp.borgmann@gmx.de>
Stanislas Rolland <stanislas.rolland(arobas)fructifor.ca>

Id

Documentation des fonctions membres

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

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

Réimplémentée à partir de t3lib_rteapi.

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

Draws the RTE as an iframe

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 à partir de t3lib_rteapi.

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::setToolBar ( )

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

tx_rtehtmlarea_base::setPlugins ( )

Disable some plugins

tx_rtehtmlarea_base::convertToolBarForHTMLArea ( $ button )

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

Paramètres:

string

buttonname (typo3-name)

Renvoie:: string buttonname (htmlarea-name)

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

Return the JS-function for setting the RTE size.

Paramètres:

	string	DivID-Name
	int	the height for the RTE
	int	the width for the RTE

Renvoie:: string Loader function in JS

tx_rtehtmlarea_base::loadJSfiles ( $ number )

Return the HTML-Code for loading the Javascript-Files

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

tx_rtehtmlarea_base::loadJScode ( $ number )

Return the JS-Code to initialize the Editor

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

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

Return the JS-Code for Register the RTE in JS

Paramètres:

	integer	$number: The index number of the RTE.
	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).

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

tx_rtehtmlarea_base::isPluginEnable ( $ plugin )

Return ture, if the plugin can loaded

Renvoie:: boolean 1 if the plugin can be loaded

tx_rtehtmlarea_base::buildJSFontSizesConfig ( $ number )

Return JS configuration of font sizes

Renvoie:: string JS font sizes configuration

tx_rtehtmlarea_base::buildJSParagraphsConfig ( $ number )

Return JS configuration of paragraphs

Renvoie:: string JS paragraphs configuration

tx_rtehtmlarea_base::buildJSFontfacesConfig ( $ number )

Return JS configuration of font faces

Renvoie:: string JS font faces configuration

tx_rtehtmlarea_base::buildJSColorsConfig ( $ number )

Return JS configuration of colors

Renvoie:: string JS colors configuration

tx_rtehtmlarea_base::buildStyleSheet ( )

Build the default content style sheet

Renvoie:: string Style sheet

tx_rtehtmlarea_base::buildJSClassesConfig ( $ number )

Return JS configuration of classes

Renvoie:: string JS classes configuration

tx_rtehtmlarea_base::buildJSClassesArray ( )

Return JS arrays of classes labels and noShow flags

Renvoie:: string JS classes arrays

tx_rtehtmlarea_base::buildJSMainLangArray ( )

Return a JS language array for htmlArea RTE

Renvoie:: string JS language array

tx_rtehtmlarea_base::buildJSAcronymArray ( )

Return an acronym array for the Acronym plugin

Renvoie:: string acronym array

tx_rtehtmlarea_base::buildJSClassesAnchorConfig ( $ number )

Return JS configuration of special anchor classes

Renvoie:: string JS special anchor classes configuration

tx_rtehtmlarea_base::buildJSClassesAnchorArray ( )

Return a JS array for special anchor classes

Renvoie:: string classesAnchor array definition

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

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

Renvoie:: string filename

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

Renvoie:: string filename

tx_rtehtmlarea_base::buildJSMainLangFile ( $ number )

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

Renvoie:: string filename

tx_rtehtmlarea_base::buildJSLangArray ( $ plugin )

Return a JS language array for the plugin

Renvoie:: string JS language array

tx_rtehtmlarea_base::getJSToolbarArray ( )

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

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

tx_rtehtmlarea_base::getLLContent ( $ string )

tx_rtehtmlarea_base::feJScharCode ( $ str )

tx_rtehtmlarea_base::getFullFileName ( $ filename )

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.

Renvoie:: string the JS-Code

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::clientInfo ( $ useragent = '' )

Client Browser Information

Usage: 4

Paramètres:

string

Alternative User Agent string (if empty, t3lib_div::getIndpEnv('HTTP_USER_AGENT') is used)

Renvoie:: array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM and FORMSTYLE

tx_rtehtmlarea_base::RTEtsConfigParams ( )

Renvoie:: [type] ...

tx_rtehtmlarea_base::cleanList ( $ str )

tx_rtehtmlarea_base::filterStyleEl	(	$	elValue,
		$	matchList
	)

tx_rtehtmlarea_base::loremIpsumInsert ( $ params )

Documentation des données membres

tx_rtehtmlarea_base::$conf_supported_browser

Valeur initiale :

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

tx_rtehtmlarea_base::$conf_toolbar_hide

Valeur initiale :

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

tx_rtehtmlarea_base::$conf_toolbar_safari_hide

Valeur initiale :

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

tx_rtehtmlarea_base::$conf_toolbar_opera_hide

Valeur initiale :

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

tx_rtehtmlarea_base::$conf_toolbar_show

Valeur initiale :

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

tx_rtehtmlarea_base::$defaultToolbarOrder

tx_rtehtmlarea_base::$defaultHotKeyList = 'selectall, bold, italic, underline, strikethrough, left, center, right, justifyfull, formatblock, paste, cleanword, undo, redo'

tx_rtehtmlarea_base::$conf_toolbar_convert

tx_rtehtmlarea_base::$defaultParagraphs

Valeur initiale :

 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',
                )

tx_rtehtmlarea_base::$defaultFontFaces

Valeur initiale :

 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',
                )

tx_rtehtmlarea_base::$defaultFontSizes

Valeur initiale :

 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)',
                )

tx_rtehtmlarea_base::$defaultFontSizes_safari

Valeur initiale :

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

tx_rtehtmlarea_base::$pluginList = 'TableOperations, ContextMenu, SpellChecker, SelectColor, TYPO3Browsers, InsertSmiley, FindReplace, RemoveFormat, CharacterMap, QuickTag, InlineCSS, DynamicCSS, UserElements, Acronym, TYPO3HtmlParser'

tx_rtehtmlarea_base::$pluginButton

Valeur initiale :

 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',
                )

tx_rtehtmlarea_base::$pluginLabel

Valeur initiale :

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

tx_rtehtmlarea_base::$spellCheckerModes = array( 'ultra', 'fast', 'normal', 'bad-spellers')

tx_rtehtmlarea_base::$RTEdivStyle

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$extHttpPath

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$siteURL

tx_rtehtmlarea_base::$hostURL

tx_rtehtmlarea_base::$typoVersion

tx_rtehtmlarea_base::$ID = 'rtehtmlarea'

Réimplémentée à partir de t3lib_rteapi.

tx_rtehtmlarea_base::$debugMode = FALSE

tx_rtehtmlarea_base::$client

tx_rtehtmlarea_base::$TCEform

tx_rtehtmlarea_base::$elementId

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$elementParts

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$tscPID

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$typeVal

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$thePid

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$RTEsetup

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$thisConfig

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$confValues

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$language

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$BECharset

tx_rtehtmlarea_base::$OutputCharset

tx_rtehtmlarea_base::$editorCSS

tx_rtehtmlarea_base::$spellCheckerLanguage

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$spellCheckerCharset

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$spellCheckerMode

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$quickTagHideTags

tx_rtehtmlarea_base::$specConf

Réimplémentée dans tx_rtehtmlarea_pi2.

tx_rtehtmlarea_base::$toolBar = array()

tx_rtehtmlarea_base::$toolbar_level_size

tx_rtehtmlarea_base::$toolbarOrderArray = array()

tx_rtehtmlarea_base::$pluginEnableList

tx_rtehtmlarea_base::$pluginEnableArray = array()

La documentation de cette classe a été générée à partir du fichier suivant :

Z:/doxygen/typo3_src-4.1.2/typo3/sysext/rtehtmlarea/class.tx_rtehtmlarea_base.php

Généré le Fri Aug 31 11:44:03 2007 pour OBLADY - Typo3 API v4.1.2 par

1.5.3


Fonctions membres publiques
	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, $table='', $uid='', $field='')
	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)
Attributs publics
	$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()