TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi Class Reference

Inheritance diagram for TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi:

Public Member Functions
	main ($parentObject)
	addButtonsToToolbar ()
	getPathToSkin ()
	buildJavascriptConfiguration ($RTEcounter)
	getExtensionKey ()
	getPathToPluginDirectory ()
	addsButtons ()
	getPluginButtons ()
	getPluginLabels ()
	getConvertToolbarForHtmlAreaArray ()
	requiresClassesConfiguration ()
	requiresSynchronousLoad ()
	setSynchronousLoad ($value=TRUE)
	getRequiredPlugins ()

Protected Attributes
	$extensionKey
	$pluginName
	$relativePathToLocallangFile
	$relativePathToSkin
	$relativePathToPluginDirectory
	$htmlAreaRTE
	$rteExtensionKey
	$thisConfig
	$toolbar
	$LOCAL_LANG
	$pluginButtons = ''
	$pluginLabels = ''
	$pluginAddsButtons = TRUE
	$convertToolbarForHtmlAreaArray = array()
	$requiresClassesConfiguration = FALSE
	$requiresSynchronousLoad = FALSE
	$requiredPlugins = ''

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! API for extending htmlArea RTE

Author

Stanislas Rolland <typo3(arobas)sjbr.ca>

Definition at line 21 of file RteHtmlAreaApi.php.

Member Function Documentation

addButtonsToToolbar()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::addButtonsToToolbar

(

)

Returns a modified toolbar order string

Returns

string a modified tollbar order list

Definition at line 115 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

addsButtons()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::addsButtons

(

)

Returns a boolean indicating whether the plugin adds buttons or not to the toolbar

Returns

boolean

Definition at line 179 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$pluginAddsButtons.

buildJavascriptConfiguration()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::buildJavascriptConfiguration

(

$RTEcounter

)

Return JS configuration of the htmlArea plugins registered by the extension

Parameters

integer

Relative id of the RTE editing area in the form

Returns

string JS configuration for registered plugins

Definition at line 141 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$pluginButtons, $TSFE, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

getConvertToolbarForHtmlAreaArray()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getConvertToolbarForHtmlAreaArray

(

)

Returns the conversion array from TYPO3 button names to htmlArea button names

Returns

array the conversion array from TYPO3 button names to htmlArea button names

Definition at line 206 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$convertToolbarForHtmlAreaArray.

getExtensionKey()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getExtensionKey

(

)

Returns the extension key

Returns

string the extension key

Definition at line 161 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$extensionKey.

getPathToPluginDirectory()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getPathToPluginDirectory

(

)

Returns the path to the plugin directory, if any

Returns

string the full path to the plugin directory

Definition at line 170 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\siteRelPath().

getPathToSkin()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getPathToSkin

(

)

Returns the path to the skin component (button icons) that should be added to linked stylesheets

Returns

string path to the skin (css) file

Definition at line 126 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$relativePathToSkin, and $TYPO3_CONF_VARS.

getPluginButtons()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getPluginButtons

(

)

Returns the list of buttons implemented by the plugin

Returns

string the list of buttons implemented by the plugin

Definition at line 188 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$pluginButtons.

getPluginLabels()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getPluginLabels

(

)

Returns the list of toolbar labels implemented by the plugin

Returns

string the list of labels implemented by the plugin

Definition at line 197 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$pluginLabels.

getRequiredPlugins()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getRequiredPlugins

(

)

Returns the list of plugins required by the plugin

Returns

string the list of plugins required by the plugin

Definition at line 243 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$requiredPlugins.

main()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::main

(

$parentObject

)

Returns TRUE if the plugin is available and correctly initialized

Parameters

object

Reference to parent object, which is an instance of the htmlArea RTE

Returns

boolean TRUE if this plugin object should be made available in the current environment and is correctly initialized

Definition at line 80 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$pluginName, TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$rteExtensionKey, $TSFE, $TYPO3_CONF_VARS, and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

requiresClassesConfiguration()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::requiresClassesConfiguration

(

)

Returns TRUE if the extension requires the PageTSConfig Classes configuration

Returns

boolean TRUE if the extension requires the PageTSConfig Classes configuration

Definition at line 215 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$requiresClassesConfiguration.

requiresSynchronousLoad()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::requiresSynchronousLoad

(

)

Returns TRUE if the plugin requires synchronous load

Returns

boolean TRUE if the plugin requires synchronous load

Definition at line 224 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$requiresSynchronousLoad.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\setSynchronousLoad().

setSynchronousLoad()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::setSynchronousLoad

(

$value = TRUE

)

Sets the plugin to require synchronous load or not

Parameters

boolean

$value,

the boolean value to set

Returns

void

Definition at line 234 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\requiresSynchronousLoad().

Member Data Documentation

$convertToolbarForHtmlAreaArray

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$convertToolbarForHtmlAreaArray = array()

protected

Definition at line 62 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getConvertToolbarForHtmlAreaArray().

$extensionKey

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$extensionKey

protected

Definition at line 23 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getExtensionKey().

$htmlAreaRTE

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$htmlAreaRTE

protected

Definition at line 38 of file RteHtmlAreaApi.php.

$LOCAL_LANG

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$LOCAL_LANG

protected

Definition at line 50 of file RteHtmlAreaApi.php.

$pluginAddsButtons

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$pluginAddsButtons = TRUE

protected

Definition at line 59 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\addsButtons().

$pluginButtons

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$pluginButtons = ''

protected

Definition at line 53 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\buildJavascriptConfiguration(), and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getPluginButtons().

$pluginLabels

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$pluginLabels = ''

protected

Definition at line 56 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getPluginLabels().

$pluginName

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$pluginName

protected

Definition at line 26 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\main().

$relativePathToLocallangFile

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$relativePathToLocallangFile

protected

Definition at line 29 of file RteHtmlAreaApi.php.

$relativePathToPluginDirectory

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$relativePathToPluginDirectory

protected

Definition at line 35 of file RteHtmlAreaApi.php.

$relativePathToSkin

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$relativePathToSkin

protected

Definition at line 32 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getPathToSkin().

$requiredPlugins

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$requiredPlugins = ''

protected

Definition at line 71 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getRequiredPlugins().

$requiresClassesConfiguration

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$requiresClassesConfiguration = FALSE

protected

Definition at line 65 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\requiresClassesConfiguration().

$requiresSynchronousLoad

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$requiresSynchronousLoad = FALSE

protected

Definition at line 68 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\requiresSynchronousLoad().

$rteExtensionKey

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$rteExtensionKey

protected

Definition at line 41 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\main().

$thisConfig

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$thisConfig

protected

Definition at line 44 of file RteHtmlAreaApi.php.

$toolbar

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$toolbar

protected

Definition at line 47 of file RteHtmlAreaApi.php.