TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement Class Reference

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

Public Member Functions
	__construct (private readonly EventDispatcherInterface $eventDispatcher, private readonly UriBuilder $uriBuilder, private readonly Locales $locales,)
	render ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
	injectNodeFactory (NodeFactory $nodeFactory)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
	setData (array $data)

Protected Member Functions
	getLanguageIsoCodeOfContent ()
	resolveCkEditorConfiguration ()
	getExtraPlugins ()
	replaceLanguageFileReferences (array $configuration)
	replaceAbsolutePathsToRelativeResourcesPath (array $configuration)
	resolveUrlPath (string $value)
array	prepareConfigurationForEditor ()
	sanitizeFieldId (string $itemFormElementName)
	translationExists (string $language)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
array	renderFieldInformation ()
array	renderFieldControl ()
array	renderFieldWizard ()
	renderLabel (string $for)
	wrapWithFieldsetAndLegend (string $innerHTML)
	hasNullCheckboxButNoPlaceholder ()
	hasNullCheckboxWithPlaceholder ()
string	formatValue ($format, $itemValue, $formatOptions=[])
int	formMaxWidth ($size=48)
	resolveJavaScriptEvaluation (array $resultArray, string $name, ?object $evalObject)
string	checkBoxParams (string $itemName, int $formElementValue, int $checkbox, int $checkboxesCount, array $fieldChangeFuncs=[], bool $invert=false)
	calculateColumnMarkup (int $cols)
	appendValueToLabelInDebugMode (string|int $label, string|int $value)
	getLanguageService ()
	getBackendUser ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
	initializeResultArray ()
array	mergeChildReturnIntoExistingResult (array $existing, array $childReturn, bool $mergeHtml=true)
	getValidationDataAsJsonString (array $config)

Protected Attributes
array	$defaultFieldInformation
array	$defaultFieldWizard
array	$rteConfiguration = array( )
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement
int	$defaultInputWidth = 30
int	$minimumInputWidth = 10
int	$maxInputWidth = 50
NodeFactory	$nodeFactory
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Form\AbstractNode
array	$data = []
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	(	private readonly EventDispatcherInterface	$eventDispatcher,
		private readonly UriBuilder	$uriBuilder,
		private readonly Locales	$locales
	)

Definition at line 78 of file RichTextElement.php.

Member Function Documentation

getExtraPlugins()

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

protected

Get configuration of external/additional plugins

Definition at line 217 of file RichTextElement.php.

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

getLanguageIsoCodeOfContent()

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

protected

Determine the contents language iso code

Definition at line 172 of file RichTextElement.php.

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 301 of file RichTextElement.php.

References $GLOBALS, TYPO3\CMS\Backend\Form\Element\AbstractFormElement\getBackendUser(), TYPO3\CMS\Core\Core\Environment\getContext(), 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\resolveCkEditorConfiguration().

render()

TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::render

(

)

Renders the ckeditor element

Exceptions

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

Definition at line 89 of file RichTextElement.php.

References TYPO3\CMS\Core\Page\JavaScriptModuleInstruction\create(), 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(), TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\resolveCkEditorConfiguration(), TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\sanitizeFieldId(), TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\translationExists(), and TYPO3\CMS\Backend\Form\Element\AbstractFormElement\wrapWithFieldsetAndLegend().

replaceAbsolutePathsToRelativeResourcesPath()

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

protected

Add configuration to replace absolute EXT: paths with relative ones

Definition at line 275 of file RichTextElement.php.

References TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath(), and TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\resolveUrlPath().

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

replaceLanguageFileReferences()

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

protected

Add configuration to replace LLL: references with the translated value

Definition at line 260 of file RichTextElement.php.

References TYPO3\CMS\Backend\Form\Element\AbstractFormElement\getLanguageService().

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

resolveCkEditorConfiguration()

TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::resolveCkEditorConfiguration ( )

protected

Definition at line 194 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().

resolveUrlPath()

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

protected

Resolves an EXT: syntax file to an absolute web URL

Definition at line 290 of file RichTextElement.php.

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

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

sanitizeFieldId()

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

protected

Definition at line 351 of file RichTextElement.php.

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

translationExists()

TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement::translationExists ( string  $language )

protected

Definition at line 357 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.

$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.