Inheritance diagram for TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement:

Public Member Functions
	__construct (NodeFactory $nodeFactory, array $data, EventDispatcherInterface $eventDispatcher=null)

array	render ()

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

Protected Member Functions
string	getLanguageIsoCodeOfContent ()

string	getCkEditorRequireJsModuleCode (string $fieldId)

array	getExtraPlugins ()

array	replaceLanguageFileReferences (array $configuration)

array	replaceAbsolutePathsToRelativeResourcesPath (array $configuration)

string	resolveUrlPath (string $value)

array	prepareConfigurationForEditor ()

string	sanitizeFieldId (string $itemFormElementName)

BackendUserAuthentication	getBackendUser ()

‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
array	renderFieldInformation ()

array	renderFieldControl ()

array	renderFieldWizard ()

bool	hasNullCheckboxButNoPlaceholder ()

bool	hasNullCheckboxWithPlaceholder ()

string	formatValue ($format, $itemValue, $formatOptions=[])

int	formMaxWidth ($size=48)

string	checkBoxParams ($itemName, $formElementValue, $checkbox, $checkboxesCount, $additionalJavaScript='')

array	calculateColumnMarkup (int $cols)

string	appendValueToLabelInDebugMode ($label, $value)

LanguageService	getLanguageService ()

‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
array	initializeResultArray ()

array	mergeChildReturnIntoExistingResult (array $existing, array $childReturn, bool $mergeHtml=true)

string	getValidationDataAsJsonString (array $config)

Protected Attributes
array	$defaultFieldInformation

array	$defaultFieldWizard

array	$rteConfiguration = array( )

EventDispatcherInterface	$eventDispatcher

‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
int	$defaultInputWidth = 30

int	$minimumInputWidth = 10

int	$maxInputWidth = 50

IconFactory	$iconFactory

‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
NodeFactory	$nodeFactory

array	$data = array( )

array	$defaultFieldInformation = array( )

array	$defaultFieldControl = array( )

array	$defaultFieldWizard = array( )

Detailed Description

Render rich text editor in FormEngine

This is a specific Backend FormEngine implementation and is not considered part of the Public TYPO3 API.

Definition at line 37 of file RichTextElement.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::__construct	(	NodeFactory	$nodeFactory,
		array	$data,
		EventDispatcherInterface	$eventDispatcher = `null`
	)

Container objects give $nodeFactory down to other containers.

Parameters

NodeFactory	$nodeFactory
array	$data
EventDispatcherInterface \| null	$eventDispatcher

Definition at line 89 of file RichTextElement.php.

References TYPO3\CMS\Backend\Form\AbstractNode\$data, TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\$eventDispatcher, and TYPO3\CMS\Backend\Form\AbstractNode\$nodeFactory.

Member Function Documentation

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::getBackendUser ( )

protected

Returns: ‪BackendUserAuthentication

Reimplemented from TYPO3\CMS\Backend\Form\Element\AbstractFormElement.

Definition at line 432 of file RichTextElement.php.

References $GLOBALS.

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\prepareConfigurationForEditor().

◆ getCkEditorRequireJsModuleCode()

string TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::getCkEditorRequireJsModuleCode ( string $fieldId )

protected

Gets the JavaScript code for CKEditor module Compiles the configuration, and then adds plugins

Parameters

string $fieldId

Returns: ‪string

Definition at line 203 of file RichTextElement.php.

References TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getExtraPlugins(), and TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\prepareConfigurationForEditor().

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

◆ getExtraPlugins()

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::getExtraPlugins ( )

protected

Get configuration of external/additional plugins

Returns: ‪array

Definition at line 279 of file RichTextElement.php.

References TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\resolveUrlPath().

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getCkEditorRequireJsModuleCode().

◆ getLanguageIsoCodeOfContent()

string TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::getLanguageIsoCodeOfContent ( )

protected

Determine the contents language iso code

Returns: ‪string

Definition at line 172 of file RichTextElement.php.

References $locales.

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\prepareConfigurationForEditor().

◆ prepareConfigurationForEditor()

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::prepareConfigurationForEditor ( )

protected

Compiles the configuration set from the outside to have it easily injected into the CKEditor.

Returns: ‪array the configuration

Definition at line 374 of file RichTextElement.php.

References TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getBackendUser(), TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getLanguageIsoCodeOfContent(), TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\replaceAbsolutePathsToRelativeResourcesPath(), and TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\replaceLanguageFileReferences().

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getCkEditorRequireJsModuleCode().

◆ render()

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::render ( )

Renders the ckeditor element

Returns: ‪array

Exceptions

Reimplemented from TYPO3\CMS\Backend\Form\AbstractNode.

Definition at line 101 of file RichTextElement.php.

References TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getCkEditorRequireJsModuleCode(), TYPO3\CMS\Backend\Form\AbstractNode\getValidationDataAsJsonString(), TYPO3\CMS\Backend\Form\AbstractNode\initializeResultArray(), TYPO3\CMS\Backend\Form\AbstractNode\mergeChildReturnIntoExistingResult(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldControl(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldInformation(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderFieldWizard(), and TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\sanitizeFieldId().

◆ replaceAbsolutePathsToRelativeResourcesPath()

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::replaceAbsolutePathsToRelativeResourcesPath ( array $configuration )

protected

Add configuration to replace absolute EXT: paths with relative ones

Parameters

array $configuration

Returns: ‪array

Definition at line 344 of file RichTextElement.php.

References TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\resolveUrlPath().

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\prepareConfigurationForEditor().

◆ replaceLanguageFileReferences()

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::replaceLanguageFileReferences ( array $configuration )

protected

Add configuration to replace LLL: references with the translated value

Parameters

array $configuration

Returns: ‪array

Definition at line 326 of file RichTextElement.php.

References TYPO3\CMS\Backend\Form\Element\AbstractFormElement\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\prepareConfigurationForEditor().

◆ resolveUrlPath()

string TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::resolveUrlPath ( string $value )

protected

Resolves an EXT: syntax file to an absolute web URL

Parameters

string $value

Returns: ‪string

Definition at line 362 of file RichTextElement.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath().

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getExtraPlugins(), and TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\replaceAbsolutePathsToRelativeResourcesPath().

◆ sanitizeFieldId()

string TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::sanitizeFieldId ( string $itemFormElementName )

protected

Parameters

string $itemFormElementName

Returns: ‪string

Definition at line 423 of file RichTextElement.php.

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

Member Data Documentation

◆ $defaultFieldInformation

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::$defaultFieldInformation

protected

Initial value:

= array( 
        'tcaDescription' => [
            'renderType' => 'tcaDescription',
        ],
     )

Default field information enabled for this element.

Definition at line 43 of file RichTextElement.php.

◆ $defaultFieldWizard

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::$defaultFieldWizard

protected

Initial value:

= array( 
        'localizationStateSelector' => [
            'renderType' => 'localizationStateSelector',
        ],
        'otherLanguageContent' => [
            'renderType' => 'otherLanguageContent',
            'after' => [
                'localizationStateSelector'
            ],
        ],
        'defaultLanguageDifferences' => [
            'renderType' => 'defaultLanguageDifferences',
            'after' => [
                'otherLanguageContent',
            ],
        ],
     )

Default field wizards enabled for this element.

Definition at line 53 of file RichTextElement.php.

◆ $eventDispatcher

EventDispatcherInterface TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::$eventDispatcher

protected

Definition at line 80 of file RichTextElement.php.

Referenced by TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\__construct().

◆ $rteConfiguration

array TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::$rteConfiguration = array( )

protected

This property contains configuration related to the RTE But only the .editor configuration part

Definition at line 76 of file RichTextElement.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBackendUser()

◆ getCkEditorRequireJsModuleCode()

◆ getExtraPlugins()

◆ getLanguageIsoCodeOfContent()

◆ prepareConfigurationForEditor()

◆ render()

◆ replaceAbsolutePathsToRelativeResourcesPath()

◆ replaceLanguageFileReferences()

◆ resolveUrlPath()

◆ sanitizeFieldId()

Member Data Documentation

◆ $defaultFieldInformation

◆ $defaultFieldWizard

◆ $eventDispatcher

◆ $rteConfiguration