TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi Class Reference
Inheritance diagram for TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi:
TYPO3\CMS\Rtehtmlarea\Extension\Abbreviation TYPO3\CMS\Rtehtmlarea\Extension\AboutEditor TYPO3\CMS\Rtehtmlarea\Extension\BlockElements TYPO3\CMS\Rtehtmlarea\Extension\BlockStyle TYPO3\CMS\Rtehtmlarea\Extension\CharacterMap TYPO3\CMS\Rtehtmlarea\Extension\ContextMenu TYPO3\CMS\Rtehtmlarea\Extension\CopyPaste TYPO3\CMS\Rtehtmlarea\Extension\DefaultClean TYPO3\CMS\Rtehtmlarea\Extension\DefaultImage TYPO3\CMS\Rtehtmlarea\Extension\DefaultInline TYPO3\CMS\Rtehtmlarea\Extension\DefaultLink TYPO3\CMS\Rtehtmlarea\Extension\DefinitionList TYPO3\CMS\Rtehtmlarea\Extension\EditElement TYPO3\CMS\Rtehtmlarea\Extension\EditorMode TYPO3\CMS\Rtehtmlarea\Extension\FindReplace TYPO3\CMS\Rtehtmlarea\Extension\InlineElements TYPO3\CMS\Rtehtmlarea\Extension\InsertSmiley TYPO3\CMS\Rtehtmlarea\Extension\Language TYPO3\CMS\Rtehtmlarea\Extension\MicroDataSchema TYPO3\CMS\Rtehtmlarea\Extension\Plaintext TYPO3\CMS\Rtehtmlarea\Extension\QuickTag TYPO3\CMS\Rtehtmlarea\Extension\RemoveFormat TYPO3\CMS\Rtehtmlarea\Extension\SelectFont TYPO3\CMS\Rtehtmlarea\Extension\Spellchecker TYPO3\CMS\Rtehtmlarea\Extension\TableOperations TYPO3\CMS\Rtehtmlarea\Extension\TextIndicator TYPO3\CMS\Rtehtmlarea\Extension\TextStyle TYPO3\CMS\Rtehtmlarea\Extension\Typo3Color TYPO3\CMS\Rtehtmlarea\Extension\Typo3HtmlParser TYPO3\CMS\Rtehtmlarea\Extension\Typo3Image TYPO3\CMS\Rtehtmlarea\Extension\Typo3Link TYPO3\CMS\Rtehtmlarea\Extension\UndoRedo TYPO3\CMS\Rtehtmlarea\Extension\UserElements

Public Member Functions

 main (array $configuration)
 
 buildJavascriptConfiguration ()
 
 getExtensionKey ()
 
 addsButtons ()
 
 getPluginButtons ()
 
 getPluginLabels ()
 
 getConvertToolbarForHtmlAreaArray ()
 
 requiresClassesConfiguration ()
 
 getRequiredPlugins ()
 
 setToolbar (array $toolbar)
 

Protected Member Functions

 cleanList ($str)
 
 getPageConfigLabel ($string)
 
 isFrontend ()
 
 isFrontendEditActive ()
 
 getFullFileName ($filename)
 
 writeTemporaryFile ($label, $fileExtension='js', $contents='')
 
 getLanguageService ()
 

Protected Attributes

 $extensionKey = 'rtehtmlarea'
 
 $pluginName
 
 $relativePathToSkin = ''
 
 $toolbar
 
 $pluginButtons = ''
 
 $pluginLabels = ''
 
 $pluginAddsButtons = true
 
 $convertToolbarForHtmlAreaArray = []
 
 $requiresClassesConfiguration = false
 
 $requiredPlugins = ''
 
 $configuration
 

Detailed Description

API for extending htmlArea RTE

Definition at line 25 of file RteHtmlAreaApi.php.

Member Function Documentation

◆ addsButtons()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::addsButtons ( )

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

Returns
bool

Definition at line 156 of file RteHtmlAreaApi.php.

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

◆ buildJavascriptConfiguration()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::buildJavascriptConfiguration ( )

Return JS configuration of the htmlArea plugins registered by the extension

Returns
string JS configuration for registered plugins

Definition at line 127 of file RteHtmlAreaApi.php.

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

◆ cleanList()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::cleanList (   $str)
protected

Clean list

Parameters
string$str
Returns
string

Definition at line 227 of file RteHtmlAreaApi.php.

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

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\ContextMenu\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\Typo3Color\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\BlockElements\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\InlineElements\buildJavascriptConfiguration(), and TYPO3\CMS\Rtehtmlarea\Extension\SelectFont\buildJSFontItemsConfig().

◆ 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 186 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 146 of file RteHtmlAreaApi.php.

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

◆ getFullFileName()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getFullFileName (   $filename)
protected

Make a file name relative to the PATH_site or to the PATH_typo3

Parameters
string$filename,a file name of the form EXT:.... or relative to the PATH_site
Returns
string the file name relative to the PATH_site if in frontend or relative to the PATH_typo3 if in backend

Definition at line 281 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontend(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontendEditActive(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\siteRelPath().

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\MicroDataSchema\buildJavascriptConfiguration(), and TYPO3\CMS\Rtehtmlarea\Extension\Typo3Link\buildJSClassesAnchorArray().

◆ getLanguageService()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getLanguageService ( )
protected

Get language service, instantiate if not there, yet

Returns
LanguageService

Definition at line 336 of file RteHtmlAreaApi.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\MicroDataSchema\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\Language\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\BlockElements\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\InlineElements\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\Typo3Link\buildJSClassesAnchorArray(), TYPO3\CMS\Rtehtmlarea\Extension\SelectFont\buildJSFontItemsConfig(), and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getPageConfigLabel().

◆ getPageConfigLabel()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::getPageConfigLabel (   $string)
protected

Resolve a label and do some funny quoting.

Parameters
string$stringGiven label name
Returns
string Resolved label

Definition at line 243 of file RteHtmlAreaApi.php.

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

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\Typo3Color\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\BlockElements\buildJavascriptConfiguration(), and TYPO3\CMS\Rtehtmlarea\Extension\SelectFont\buildJSFontItemsConfig().

◆ 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 166 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 176 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 206 of file RteHtmlAreaApi.php.

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

◆ isFrontend()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::isFrontend ( )
protected

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

Returns
bool

Definition at line 256 of file RteHtmlAreaApi.php.

References $GLOBALS, and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontendEditActive().

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\Spellchecker\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getFullFileName(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\main(), and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\writeTemporaryFile().

◆ isFrontendEditActive()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::isFrontendEditActive ( )
protected

Checks whether frontend editing is active.

Returns
bool

Definition at line 268 of file RteHtmlAreaApi.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\Spellchecker\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getFullFileName(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontend(), and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\writeTemporaryFile().

◆ main()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::main ( array  $configuration)

Returns TRUE if the plugin is available and correctly initialized

Parameters
array$configurationConfiguration array given from calling object down to the single plugins
Returns
bool TRUE if this plugin object should be made available in the current environment and is correctly initialized

Definition at line 110 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\$configuration, $GLOBALS, and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontend().

◆ requiresClassesConfiguration()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::requiresClassesConfiguration ( )

Returns TRUE if the extension requires the PageTSConfig Classes configuration

Returns
bool TRUE if the extension requires the PageTSConfig Classes configuration

Definition at line 196 of file RteHtmlAreaApi.php.

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

◆ setToolbar()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::setToolbar ( array  $toolbar)

Set toolbal

Parameters
array$toolbar

Definition at line 216 of file RteHtmlAreaApi.php.

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

◆ writeTemporaryFile()

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::writeTemporaryFile (   $label,
  $fileExtension = 'js',
  $contents = '' 
)
protected

Writes contents in a file in typo3temp and returns the file name

Parameters
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
Returns
string The name of the file written to typo3temp
Exceptions

Definition at line 309 of file RteHtmlAreaApi.php.

References TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontend(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\isFrontendEditActive(), TYPO3\CMS\Core\Utility\GeneralUtility\minifyJavaScript(), TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath(), TYPO3\CMS\Core\Utility\GeneralUtility\shortMD5(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFileToTypo3tempDir().

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\MicroDataSchema\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\Typo3Link\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\Language\buildJavascriptConfiguration(), TYPO3\CMS\Rtehtmlarea\Extension\Abbreviation\buildJavascriptConfiguration(), and TYPO3\CMS\Rtehtmlarea\Extension\SelectFont\buildJSFontItemsConfig().

Member Data Documentation

◆ $configuration

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$configuration
protected

Definition at line 102 of file RteHtmlAreaApi.php.

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

◆ $convertToolbarForHtmlAreaArray

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$convertToolbarForHtmlAreaArray = []
protected

Definition at line 81 of file RteHtmlAreaApi.php.

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

◆ $extensionKey

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$extensionKey = 'rtehtmlarea'
protected

Definition at line 32 of file RteHtmlAreaApi.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Extension\Typo3Link\buildJavascriptConfiguration(), and TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi\getExtensionKey().

◆ $pluginAddsButtons

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$pluginAddsButtons = true
protected

Definition at line 74 of file RteHtmlAreaApi.php.

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

◆ $pluginButtons

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

Definition at line 60 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 67 of file RteHtmlAreaApi.php.

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

◆ $pluginName

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$pluginName
protected

Definition at line 39 of file RteHtmlAreaApi.php.

◆ $relativePathToSkin

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$relativePathToSkin = ''
protected

Definition at line 46 of file RteHtmlAreaApi.php.

◆ $requiredPlugins

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

Definition at line 95 of file RteHtmlAreaApi.php.

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

◆ $requiresClassesConfiguration

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$requiresClassesConfiguration = false
protected

Definition at line 88 of file RteHtmlAreaApi.php.

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

◆ $toolbar

TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi::$toolbar
protected

Definition at line 53 of file RteHtmlAreaApi.php.

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