Public Member Functions
	__construct (protected array $configuration)

	get ()

Protected Member Functions
	migrateExtraPlugins ()

	migrateRemovePlugins ()

	migrateToolbarItems (array $items)

	migrateToolbarButton (string $buttonName)

	migrateToolbarButtons (array $toolbarItems)

	migrateToolbarSpacers (array $toolbarItems)

	migrateToolbarLinebreaks (array $toolbarItems)

	migrateToolbarCleanup (array $toolbarItems)

	migrateRemoveButtonsFromToolbar ()

	migrateFormatTagsToHeadings ()

	migrateStylesSetToStyleDefinitions ()

	migrateContentsCssToArray ()

	migrateTypo3LinkAdditionalAttributes ()

	parseRuleProperties (string $properties, string $type)

	parseRulesString (string $input)

	migrateAllowedContent ()

	handleAlignmentPlugin ()

	handleWhitespacePlugin ()

	handleWordCountPlugin ()

	addLinkClassesToStyleSets ()

Private Member Functions
	removeToolbarItem (string $name)

	removeExtraPlugin (string $name)

	getUniqueArrayValues (array $array)

Private Attributes
const	TOOLBAR_MAIN_GROUPS_MAP

const	TOOLBAR_GROUPS_MAP

const	BUTTON_MAP

const	PLUGIN_MAP

Detailed Description

Definition at line 25 of file CKEditor5Migrator.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::__construct ( protected array $configuration )

Parameters

array $configuration ‪Richtext configuration

Definition at line 250 of file CKEditor5Migrator.php.

Member Function Documentation

◆ addLinkClassesToStyleSets()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::addLinkClassesToStyleSets ( )

protected

Definition at line 954 of file CKEditor5Migrator.php.

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

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ get()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::get ( )

Definition at line 276 of file CKEditor5Migrator.php.

◆ getUniqueArrayValues()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::getUniqueArrayValues ( array $array )

private

Ensure to have clean array with incrementing identifiers to avoid JavaScript casting this to an object

Definition at line 1022 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateRemovePlugins(), TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeExtraPlugin(), and TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeToolbarItem().

◆ handleAlignmentPlugin()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::handleAlignmentPlugin ( )

protected

Definition at line 823 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeExtraPlugin(), and TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeToolbarItem().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ handleWhitespacePlugin()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::handleWhitespacePlugin ( )

protected

Definition at line 892 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeToolbarItem().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ handleWordCountPlugin()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::handleWordCountPlugin ( )

protected

Definition at line 912 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateAllowedContent()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateAllowedContent ( )

protected

Definition at line 737 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\parseRulesString().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateContentsCssToArray()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateContentsCssToArray ( )

protected

Definition at line 640 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateExtraPlugins()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateExtraPlugins ( )

protected

Definition at line 281 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeExtraPlugin().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateFormatTagsToHeadings()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateFormatTagsToHeadings ( )

protected

Definition at line 558 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateRemoveButtonsFromToolbar()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateRemoveButtonsFromToolbar ( )

protected

Definition at line 525 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\removeToolbarItem(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateRemovePlugins()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateRemovePlugins ( )

protected

Definition at line 297 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\getUniqueArrayValues().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateStylesSetToStyleDefinitions()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateStylesSetToStyleDefinitions ( )

protected

Definition at line 606 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ migrateToolbarButton()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateToolbarButton ( string $buttonName )

protected

Definition at line 437 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarButtons(), and TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarItems().

◆ migrateToolbarButtons()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateToolbarButtons ( array $toolbarItems )

protected

Definition at line 445 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarButton().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarItems().

◆ migrateToolbarCleanup()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateToolbarCleanup ( array $toolbarItems )

protected

Definition at line 487 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarItems().

◆ migrateToolbarItems()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateToolbarItems ( array $items )

protected

Definition at line 362 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarButton(), TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarButtons(), TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarCleanup(), TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarLinebreaks(), and TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarSpacers().

◆ migrateToolbarLinebreaks()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateToolbarLinebreaks ( array $toolbarItems )

protected

Definition at line 474 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarItems().

◆ migrateToolbarSpacers()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateToolbarSpacers ( array $toolbarItems )

protected

Definition at line 461 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateToolbarItems().

◆ migrateTypo3LinkAdditionalAttributes()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::migrateTypo3LinkAdditionalAttributes ( )

protected

Definition at line 664 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\__construct().

◆ parseRuleProperties()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::parseRuleProperties	(	string	$properties,
		string	$type
	)

protected

Definition at line 683 of file CKEditor5Migrator.php.

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\parseRulesString().

◆ parseRulesString()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::parseRulesString ( string $input )

protected

Based on https://github.com/ckeditor/ckeditor4/blob/4.23.0-lts/core/filter.js#L1438

Definition at line 706 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\parseRuleProperties().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateAllowedContent().

◆ removeExtraPlugin()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::removeExtraPlugin ( string $name )

private

Definition at line 1000 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\getUniqueArrayValues().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\handleAlignmentPlugin(), and TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateExtraPlugins().

◆ removeToolbarItem()

TYPO3\CMS\Core\Configuration\CKEditor5Migrator::removeToolbarItem ( string $name )

private

Definition at line 994 of file CKEditor5Migrator.php.

References TYPO3\CMS\Core\Configuration\CKEditor5Migrator\getUniqueArrayValues().

Referenced by TYPO3\CMS\Core\Configuration\CKEditor5Migrator\handleAlignmentPlugin(), TYPO3\CMS\Core\Configuration\CKEditor5Migrator\handleWhitespacePlugin(), and TYPO3\CMS\Core\Configuration\CKEditor5Migrator\migrateRemoveButtonsFromToolbar().

Member Data Documentation

◆ BUTTON_MAP

const TYPO3\CMS\Core\Configuration\CKEditor5Migrator::BUTTON_MAP

private

Definition at line 83 of file CKEditor5Migrator.php.

◆ PLUGIN_MAP

const TYPO3\CMS\Core\Configuration\CKEditor5Migrator::PLUGIN_MAP

private

Mapping of plugins

Definition at line 180 of file CKEditor5Migrator.php.

◆ TOOLBAR_GROUPS_MAP

const TYPO3\CMS\Core\Configuration\CKEditor5Migrator::TOOLBAR_GROUPS_MAP

private

Initial value:

= [
        'mode' => ['Source'],
        'document' => ['Save', 'NewPage', 'Preview', 'Print'],
        'doctools' => ['Templates'],
        'clipboard' => ['Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord'],
        'undo' => ['Undo', 'Redo'],
        'find' => ['Find', 'Replace'],
        'selection' => ['SelectAll'],
        'spellchecker' => ['Scayt'],
        'forms' => ['Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField'],
        'basicstyles' => ['Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', 'SoftHyphen'],
        'cleanup' => ['CopyFormatting', 'RemoveFormat'],
        'list' => ['NumberedList', 'BulletedList'],
        'indent' => ['Indent', 'Outdent'],
        'blocks' => ['Blockquote', 'CreateDiv'],
        'align' => ['JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock'],
        'bidi' => ['BidiLtr', 'BidiRtl', 'Language'],
        'links' => ['Link', 'Unlink', 'Anchor'],
        'insert' => ['Image', 'Flash', 'Table', 'HorizontalRule', 'Smiley', 'SpecialChar', 'PageBreak', 'Iframe'],
        'styles' => ['Styles', 'Format', 'Font', 'FontSize'],
        'format' => ['Format'],
        'table' => ['Table'],
        'specialchar' => ['SpecialChar'],
        'colors' => ['TextColor', 'BGColor'],
        'tools' => ['Maximize', 'ShowBlocks'],
        'about' => ['About'],
        'others' => [],
    ]

Groups in CKEditor4 contain buttons.

Definition at line 53 of file CKEditor5Migrator.php.

◆ TOOLBAR_MAIN_GROUPS_MAP

const TYPO3\CMS\Core\Configuration\CKEditor5Migrator::TOOLBAR_MAIN_GROUPS_MAP

private

Initial value:

= [
        'document' => ['mode', 'document', 'doctools'],
        'clipboard' => ['clipboard', 'undo'],
        'editing' => ['find', 'selection', 'spellchecker', 'editing'],
        'forms' => ['forms'],
        'basicstyles' => ['basicstyles', 'cleanup'],
        'paragraph' => ['list', 'indent', 'blocks', 'align', 'bidi', 'paragraph'],
        'links' => ['links'],
        'insert' => ['insert'],
        'styles' => ['styles'],
        'colors' => ['colors'],
        'tools' => ['tools'],
        'others' => ['others'],
        'about' => ['about'],
        'blocks' => ['blocks'],
        'table' => ['table'],
        'tabletools' => [],
    ]

Main groups in CKEditor4 contain subgroups. These groups are expanded during migration.

Definition at line 31 of file CKEditor5Migrator.php.

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLinkClassesToStyleSets()

◆ get()

◆ getUniqueArrayValues()

◆ handleAlignmentPlugin()

◆ handleWhitespacePlugin()

◆ handleWordCountPlugin()

◆ migrateAllowedContent()

◆ migrateContentsCssToArray()

◆ migrateExtraPlugins()

◆ migrateFormatTagsToHeadings()

◆ migrateRemoveButtonsFromToolbar()

◆ migrateRemovePlugins()

◆ migrateStylesSetToStyleDefinitions()

◆ migrateToolbarButton()

◆ migrateToolbarButtons()

◆ migrateToolbarCleanup()

◆ migrateToolbarItems()

◆ migrateToolbarLinebreaks()

◆ migrateToolbarSpacers()

◆ migrateTypo3LinkAdditionalAttributes()

◆ parseRuleProperties()

◆ parseRulesString()

◆ removeExtraPlugin()

◆ removeToolbarItem()

Member Data Documentation

◆ BUTTON_MAP

◆ PLUGIN_MAP

◆ TOOLBAR_GROUPS_MAP

◆ TOOLBAR_MAIN_GROUPS_MAP