TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement Class Reference
Inheritance diagram for TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement:
TYPO3\CMS\Backend\Form\Element\AbstractFormElement TYPO3\CMS\Backend\Form\AbstractNode TYPO3\CMS\Backend\Form\NodeInterface

Public Member Functions

 render ()
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Form\Element\AbstractFormElement
 __construct (NodeFactory $nodeFactory, array $data)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Form\AbstractNode
 __construct (NodeFactory $nodeFactory, array $data)
 
 render ()
 

Protected Member Functions

 getRteInitJsCode ()
 
 getContentCssFileNames ()
 
 isPluginEnabled ($pluginId)
 
 buildJSClassesArray ()
 
 hasCircularDependency (&$classesArray, $requiringClass, $initialClass, $recursionLevel=0)
 
 buildNestedJSArray ($conf)
 
 writeTemporaryFile ($label, $fileExtension='js', $contents='')
 
 getJSToolbarArray ()
 
 getFullFileName ($filename)
 
 addOnSubmitJavaScriptCode ()
 
 isFrontendEditActive ()
 
 clientInfo ()
 
 logDeprecatedProperty ($deprecatedProperty, $useProperty, $version)
 
 RTEtsConfigParams ()
 
 cleanList ($str)
 
 isInFullScreenMode ()
 
 getLanguageService ()
 
 getBackendUserAuthentication ()
 
 getDatabaseConnection ()
 
- Protected Member Functions inherited from TYPO3\CMS\Backend\Form\Element\AbstractFormElement
 isWizardsDisabled ()
 
 formMaxWidth ($size=48)
 
 getClipboardElements ($allowed, $mode)
 
 getLanguageService ()
 
- Protected Member Functions inherited from TYPO3\CMS\Backend\Form\AbstractNode
 initializeResultArray ()
 
 mergeChildReturnIntoExistingResult (array $existing, array $childReturn)
 
 getValidationDataAsDataAttribute (array $config)
 
 getValidationDataAsJsonString (array $config)
 

Protected Attributes

 $resultArray
 
 $pidOfPageRecord
 
 $pidOfVersionedMotherRecord
 
 $vanillaRteTsConfig
 
 $processedRteConfiguration
 
 $domIdentifier
 
 $defaultExtras
 
 $client
 
 $language
 
 $contentTypo3Language
 
 $contentISOLanguage
 
 $contentLanguageUid
 
 $defaultToolbarOrder
 
 $convertToolbarForHtmlAreaArray
 
 $toolbar = []
 
 $toolbarOrderArray = []
 
 $pluginButton = []
 
 $pluginLabel = []
 
 $pluginEnabledArray = []
 
 $pluginEnabledCumulativeArray = []
 
 $registeredPlugins = []
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Form\Element\AbstractFormElement
 $defaultInputWidth = 30
 
 $minimumInputWidth = 10
 
 $maxInputWidth = 50
 
 $clipboard = null
 
 $iconFactory
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Form\AbstractNode
 $data = []
 

Detailed Description

Render rich text editor in FormEngine

Definition at line 36 of file RichTextElement.php.

Member Function Documentation

◆ addOnSubmitJavaScriptCode()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::addOnSubmitJavaScriptCode ( )
protected

Return the Javascript code for copying the HTML code from the editor into the hidden input field.

Returns
void

Definition at line 1125 of file RichTextElement.php.

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

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render().

◆ buildJSClassesArray()

◆ buildNestedJSArray()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::buildNestedJSArray (   $conf)
protected

Translate Page TS Config array in JS nested array definition Replace 0 values with false Unquote regular expression values Replace empty arrays with empty objects

Parameters
array$conf,Page TSConfig configuration array
Returns
string nested JS array definition

Definition at line 934 of file RichTextElement.php.

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

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\buildJSClassesArray(), and TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getRteInitJsCode().

◆ cleanList()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::cleanList (   $str)
protected

◆ clientInfo()

◆ getBackendUserAuthentication()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::getBackendUserAuthentication ( )
protected

◆ getContentCssFileNames()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::getContentCssFileNames ( )
protected

Get the name of the contentCSS files to use

Returns
array An array of full file name of the content css files to use

Definition at line 778 of file RichTextElement.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), and TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getFullFileName().

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getRteInitJsCode().

◆ getDatabaseConnection()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::getDatabaseConnection ( )
protected
Returns
DatabaseConnection

Definition at line 1342 of file RichTextElement.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\clientInfo().

◆ getFullFileName()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::getFullFileName (   $filename)
protected

◆ getJSToolbarArray()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::getJSToolbarArray ( )
protected

Return the JS code of the toolbar configuration for the HTMLArea editor

Returns
string The JS code as nested JS arrays

Definition at line 1041 of file RichTextElement.php.

References TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$toolbar.

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getRteInitJsCode().

◆ getLanguageService()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::getLanguageService ( )
protected

◆ getRteInitJsCode()

◆ hasCircularDependency()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::hasCircularDependency ( $classesArray,
  $requiringClass,
  $initialClass,
  $recursionLevel = 0 
)
protected

Check for possible circularity in classes dependencies

Parameters
array$classesArray,reference to the array of classes dependencies
string$requiringClass,class requiring at some iteration level from the initial requiring class
string$initialClass,initial class from which a circular relationship is being searched
int$recursionLevel,depth of recursive call
Returns
bool TRUE, if a circular relationship is found

Definition at line 905 of file RichTextElement.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\buildJSClassesArray().

◆ isFrontendEditActive()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::isFrontendEditActive ( )
protected

Checks if frontend editing is active.

Returns
bool TRUE if frontend editing is active

Definition at line 1141 of file RichTextElement.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getFullFileName().

◆ isInFullScreenMode()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::isInFullScreenMode ( )
protected

True if RTE is in full screen mode / called via wizard controller

Returns
bool

Definition at line 1318 of file RichTextElement.php.

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

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getRteInitJsCode(), and TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render().

◆ isPluginEnabled()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::isPluginEnabled (   $pluginId)
protected

Return TRUE, if the plugin can be loaded

Parameters
string$pluginId,The identification string of the plugin
Returns
bool TRUE if the plugin can be loaded

Definition at line 806 of file RichTextElement.php.

Referenced by TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getRteInitJsCode(), and TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\render().

◆ logDeprecatedProperty()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::logDeprecatedProperty (   $deprecatedProperty,
  $useProperty,
  $version 
)
protected

Log usage of deprecated Page TS Config Property

Parameters
string$deprecatedProperty,Name of deprecated property
string$useProperty,Name of property to use instead
string$version,Version of TYPO3 in which the property will be removed
Returns
void

Definition at line 1225 of file RichTextElement.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getBackendUserAuthentication(), and TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getLanguageService().

◆ render()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::render ( )

This will render a <textarea> OR RTE area form field, possibly with various control/validation features

Returns
array As defined in initializeResultArray() of AbstractNode

Implements TYPO3\CMS\Backend\Form\NodeInterface.

Definition at line 212 of file RichTextElement.php.

References TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$client, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$contentISOLanguage, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$contentLanguageUid, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$contentTypo3Language, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$defaultExtras, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$defaultToolbarOrder, $GLOBALS, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$language, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$pluginEnabledArray, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$processedRteConfiguration, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$resultArray, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$vanillaRteTsConfig, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\addOnSubmitJavaScriptCode(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\clientInfo(), TYPO3\CMS\Backend\Utility\BackendUtility\fixVersioningPid(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getBackendUserAuthentication(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getFullFileName(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\getRteInitJsCode(), TYPO3\CMS\Backend\Utility\BackendUtility\getSpecConfParts(), TYPO3\CMS\Backend\Form\AbstractNode\getValidationDataAsDataAttribute(), TYPO3\CMS\Backend\Form\AbstractNode\initializeResultArray(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\isInFullScreenMode(), TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\isPluginEnabled(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Backend\Utility\BackendUtility\RTEsetup(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\underscoredToUpperCamelCase().

◆ RTEtsConfigParams()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::RTEtsConfigParams ( )
protected

◆ writeTemporaryFile()

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::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 952 of file RichTextElement.php.

References $GLOBALS, TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement\$language, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), 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\Form\Element\RichTextElement\getRteInitJsCode().

Member Data Documentation

◆ $client

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$client
protected

◆ $contentISOLanguage

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$contentISOLanguage
protected

◆ $contentLanguageUid

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$contentLanguageUid
protected

◆ $contentTypo3Language

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$contentTypo3Language
protected

◆ $convertToolbarForHtmlAreaArray

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$convertToolbarForHtmlAreaArray
protected
Initial value:
= [
'space' => 'space'

Definition at line 151 of file RichTextElement.php.

◆ $defaultExtras

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$defaultExtras
protected

◆ $defaultToolbarOrder

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$defaultToolbarOrder
protected

◆ $domIdentifier

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$domIdentifier
protected

Definition at line 95 of file RichTextElement.php.

◆ $language

◆ $pidOfPageRecord

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$pidOfPageRecord
protected

◆ $pidOfVersionedMotherRecord

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$pidOfVersionedMotherRecord
protected

◆ $pluginButton

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$pluginButton = []
protected

Definition at line 176 of file RichTextElement.php.

◆ $pluginEnabledArray

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$pluginEnabledArray = []
protected

◆ $pluginEnabledCumulativeArray

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$pluginEnabledCumulativeArray = []
protected

Definition at line 197 of file RichTextElement.php.

◆ $pluginLabel

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$pluginLabel = []
protected

Definition at line 183 of file RichTextElement.php.

◆ $processedRteConfiguration

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$processedRteConfiguration
protected

◆ $registeredPlugins

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$registeredPlugins = []
protected

Definition at line 204 of file RichTextElement.php.

◆ $resultArray

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$resultArray
protected

◆ $toolbar

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$toolbar = []
protected

◆ $toolbarOrderArray

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$toolbarOrderArray = []
protected

Definition at line 169 of file RichTextElement.php.

◆ $vanillaRteTsConfig

TYPO3\CMS\Rtehtmlarea\Form\Element\RichTextElement::$vanillaRteTsConfig
protected