function Core::computeCKEditor5PluginSubsetConfiguration

Overrides CKEditor4To5UpgradePluginInterface::computeCKEditor5PluginSubsetConfiguration

File

core/modules/ckeditor5/src/Plugin/CKEditor4To5Upgrade/Core.php, line 221

Class

Core

Provides the CKEditor 4 to 5 upgrade for Drupal core's CKEditor plugins.

Namespace

Code

public function computeCKEditor5PluginSubsetConfiguration(string $cke5_plugin_id, FilterFormatInterface $text_format) : ?array {
    switch ($cke5_plugin_id) {
        case 'ckeditor5_heading':
            $restrictions = $text_format->getHtmlRestrictions();
            if ($restrictions === FALSE) {
                // The default is to allow all headings, which makes sense when there
                // are no restrictions.
                // @see \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Heading::DEFAULT_CONFIGURATION
                return NULL;
            }
            // Otherwise, only enable headings that allowed by the restrictions.
            $configuration = [];
            foreach (range(1, 6) as $index) {
                // Merely checking the existence of the array key is sufficient; this
                // plugin does not set or need any additional attributes.
                // @see \Drupal\filter\Plugin\FilterInterface::getHTMLRestrictions()
                if (array_key_exists("h{$index}", $restrictions['allowed'])) {
                    $configuration['enabled_headings'][] = "heading{$index}";
                }
            }
            return $configuration;
        case 'ckeditor5_alignment':
            $alignment_classes_to_types = [
                'text-align-left' => 'left',
                'text-align-right' => 'right',
                'text-align-center' => 'center',
                'text-align-justify' => 'justify',
            ];
            $restrictions = $text_format->getHtmlRestrictions();
            if ($restrictions === FALSE) {
                // The default is to allow all alignments. This makes sense when there
                // are no restrictions.
                // @see \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Alignment::DEFAULT_CONFIGURATION
                return NULL;
            }
            // Otherwise, enable alignment types based on the provided restrictions.
            // I.e. if a tag is found with a text-align-{alignment type} class,
            // activate that alignment type.
            $configuration = [];
            foreach ($restrictions['allowed'] as $tag) {
                $classes = isset($tag['class']) && is_array($tag['class']) ? $tag['class'] : [];
                foreach (array_keys($classes) as $class) {
                    if (isset($alignment_classes_to_types[$class])) {
                        $configuration['enabled_alignments'][] = $alignment_classes_to_types[$class];
                    }
                }
            }
            if (isset($configuration['enabled_alignments'])) {
                $configuration['enabled_alignments'] = array_unique($configuration['enabled_alignments']);
            }
            return $configuration;
        case 'ckeditor5_list':
            $restrictions = $text_format->getHtmlRestrictions();
            if ($restrictions === FALSE) {
                // The default is to allow a reversed list and a start index, which makes sense when there
                // are no restrictions.
                // @see \Drupal\ckeditor5\Plugin\CKEditor5Plugin\ListPlugin::default_configuration()
                return NULL;
            }
            $configuration = [];
            $configuration['properties']['reversed'] = !empty($restrictions['allowed']['ol']['reversed']);
            $configuration['properties']['startIndex'] = !empty($restrictions['allowed']['ol']['start']);
            return $configuration;
        case 'media_media':
            $restrictions = $text_format->getHtmlRestrictions();
            if ($restrictions === FALSE) {
                // The default is to not allow the user to override the default view mode.
                // @see \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Media::defaultConfiguration()
                return NULL;
            }
            $configuration = [];
            // Check if data-view-mode is allowed.
            $configuration['allow_view_mode_override'] = !empty($restrictions['allowed']['drupal-media']['data-view-mode']);
            return $configuration;
        case 'ckeditor5_style':
            // @see mapCKEditor4SettingsToCKEditor5Configuration()
            return NULL;
        default:
            throw new \OutOfBoundsException();
    }
}