class CKEditorPluginManager

Same name in other branches
  1. 8.9.x core/modules/ckeditor/src/CKEditorPluginManager.php \Drupal\ckeditor\CKEditorPluginManager

Provides a CKEditor Plugin plugin manager.

Hierarchy

Expanded class hierarchy of CKEditorPluginManager

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginButtonsInterface

\Drupal\ckeditor\CKEditorPluginContextualInterface

\Drupal\ckeditor\CKEditorPluginConfigurableInterface

\Drupal\ckeditor\CKEditorPluginCssInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\Annotation\CKEditorPlugin

Plugin API

3 files declare their use of CKEditorPluginManager
CKEditor.php in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php
CKEditorPluginManagerTest.php in core/modules/ckeditor/tests/src/Unit/CKEditorPluginManagerTest.php
Internal.php in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Internal.php
1 string reference to 'CKEditorPluginManager'
ckeditor.services.yml in core/modules/ckeditor/ckeditor.services.yml
core/modules/ckeditor/ckeditor.services.yml
1 service uses CKEditorPluginManager
plugin.manager.ckeditor.plugin in core/modules/ckeditor/ckeditor.services.yml
Drupal\ckeditor\CKEditorPluginManager

File

core/modules/ckeditor/src/CKEditorPluginManager.php, line 24

Namespace

Drupal\ckeditor
View source
class CKEditorPluginManager extends DefaultPluginManager {
    
    /**
     * Constructs a CKEditorPluginManager object.
     *
     * @param \Traversable $namespaces
     *   An object that implements \Traversable which contains the root paths
     *   keyed by the corresponding namespace to look for plugin implementations.
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
     *   Cache backend instance to use.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler to invoke the alter hook with.
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
        parent::__construct('Plugin/CKEditorPlugin', $namespaces, $module_handler, 'Drupal\\ckeditor\\CKEditorPluginInterface', 'Drupal\\ckeditor\\Annotation\\CKEditorPlugin');
        $this->alterInfo('ckeditor_plugin_info');
        $this->setCacheBackend($cache_backend, 'ckeditor_plugins');
    }
    
    /**
     * Retrieves enabled plugins' files, keyed by plugin ID.
     *
     * For CKEditor plugins that implement:
     *  - CKEditorPluginButtonsInterface, not CKEditorPluginContextualInterface,
     *     a plugin is enabled if at least one of its buttons is in the toolbar;
     *  - CKEditorPluginContextualInterface, not CKEditorPluginButtonsInterface,
     *     a plugin is enabled if its isEnabled() method returns TRUE
     *  - both of these interfaces, a plugin is enabled if either is the case.
     *
     * Internal plugins (those that are part of the bundled build of CKEditor) are
     * excluded by default, since they are loaded implicitly. If you need to know
     * even implicitly loaded (i.e. internal) plugins, then set the optional
     * second parameter.
     *
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     * @param bool $include_internal_plugins
     *   Defaults to FALSE. When set to TRUE, plugins whose isInternal() method
     *   returns TRUE will also be included.
     *
     * @return array
     *   A list of the enabled CKEditor plugins, with the plugin IDs as keys and
     *   the Drupal root-relative plugin files as values.
     *   For internal plugins, the value is NULL.
     */
    public function getEnabledPluginFiles(Editor $editor, $include_internal_plugins = FALSE) {
        $plugins = array_keys($this->getDefinitions());
        $toolbar_buttons = $this->getEnabledButtons($editor);
        $enabled_plugins = [];
        $additional_plugins = [];
        foreach ($plugins as $plugin_id) {
            $plugin = $this->createInstance($plugin_id);
            if (!$include_internal_plugins && $plugin->isInternal()) {
                continue;
            }
            $enabled = FALSE;
            // Enable this plugin if it provides a button that has been enabled.
            if ($plugin instanceof CKEditorPluginButtonsInterface) {
                $plugin_buttons = array_keys($plugin->getButtons());
                $enabled = count(array_intersect($toolbar_buttons, $plugin_buttons)) > 0;
            }
            // Otherwise enable this plugin if it declares itself as enabled.
            if (!$enabled && $plugin instanceof CKEditorPluginContextualInterface) {
                $enabled = $plugin->isEnabled($editor);
            }
            if ($enabled) {
                $enabled_plugins[$plugin_id] = $plugin->isInternal() ? NULL : $plugin->getFile();
                // Check if this plugin has dependencies that also need to be enabled.
                $additional_plugins = array_merge($additional_plugins, array_diff($plugin->getDependencies($editor), $additional_plugins));
            }
        }
        // Add the list of dependent plugins.
        foreach ($additional_plugins as $plugin_id) {
            $plugin = $this->createInstance($plugin_id);
            $enabled_plugins[$plugin_id] = $plugin->isInternal() ? NULL : $plugin->getFile();
        }
        // Always return plugins in the same order.
        asort($enabled_plugins);
        return $enabled_plugins;
    }
    
    /**
     * Gets the enabled toolbar buttons in the given text editor instance.
     *
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     *
     * @return string[]
     *   A list of the toolbar buttons enabled in the given text editor instance.
     */
    public static function getEnabledButtons(Editor $editor) {
        $toolbar_rows = [];
        $settings = $editor->getSettings();
        foreach ($settings['toolbar']['rows'] as $row_number => $row) {
            $toolbar_rows[] = array_reduce($settings['toolbar']['rows'][$row_number], function ($result, $button_group) {
                return array_merge($result, $button_group['items']);
            }, []);
        }
        return array_unique(NestedArray::mergeDeepArray($toolbar_rows));
    }
    
    /**
     * Retrieves all available CKEditor buttons, keyed by plugin ID.
     *
     * @return array
     *   All available CKEditor buttons, with plugin IDs as keys and button
     *   metadata (as implemented by getButtons()) as values.
     *
     * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface::getButtons()
     */
    public function getButtons() {
        $plugins = array_keys($this->getDefinitions());
        $buttons_plugins = [];
        foreach ($plugins as $plugin_id) {
            $plugin = $this->createInstance($plugin_id);
            if ($plugin instanceof CKEditorPluginButtonsInterface) {
                $buttons_plugins[$plugin_id] = $plugin->getButtons();
            }
        }
        return $buttons_plugins;
    }
    
    /**
     * Injects the CKEditor plugins settings forms as a vertical tabs subform.
     *
     * @param array &$form
     *   A reference to an associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     */
    public function injectPluginSettingsForm(array &$form, FormStateInterface $form_state, Editor $editor) {
        $definitions = $this->getDefinitions();
        foreach (array_keys($definitions) as $plugin_id) {
            $plugin = $this->createInstance($plugin_id);
            if ($plugin instanceof CKEditorPluginConfigurableInterface) {
                $plugin_settings_form = [];
                $form['plugins'][$plugin_id] = [
                    '#type' => 'details',
                    '#title' => $definitions[$plugin_id]['label'],
                    '#open' => TRUE,
                    '#group' => 'editor][settings][plugin_settings',
                    '#attributes' => [
                        'data-ckeditor-plugin-id' => $plugin_id,
                    ],
                ];
                // Provide enough metadata for the drupal.ckeditor.admin library to
                // allow it to automatically show/hide the vertical tab containing the
                // settings for this plugin. Only do this if it's a CKEditor plugin that
                // just provides buttons, don't do this if it's a contextually enabled
                // CKEditor plugin. After all, in the latter case, we can't know when
                // its settings should be shown!
                if ($plugin instanceof CKEditorPluginButtonsInterface && !$plugin instanceof CKEditorPluginContextualInterface) {
                    $form['plugins'][$plugin_id]['#attributes']['data-ckeditor-buttons'] = implode(' ', array_keys($plugin->getButtons()));
                }
                $form['plugins'][$plugin_id] += $plugin->settingsForm($plugin_settings_form, $form_state, $editor);
            }
        }
    }
    
    /**
     * Retrieves enabled plugins' iframe instance CSS files, keyed by plugin ID.
     *
     * @param \Drupal\editor\Entity\Editor $editor
     *   A configured text editor object.
     *
     * @return string[]
     *   Enabled plugins CKEditor CSS files, with plugin IDs as keys and CSS file
     *   paths relative to the Drupal root (as implemented by getCssFiles()) as
     *   values.
     *
     * @see \Drupal\ckeditor\CKEditorPluginCssInterface::getCssFiles()
     */
    public function getCssFiles(Editor $editor) {
        $enabled_plugins = array_keys($this->getEnabledPluginFiles($editor, TRUE));
        $css_files = [];
        foreach ($enabled_plugins as $plugin_id) {
            $plugin = $this->createInstance($plugin_id);
            if ($plugin instanceof CKEditorPluginCssInterface) {
                $css_files[$plugin_id] = $plugin->getCssFiles($editor);
            }
        }
        return $css_files;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CKEditorPluginManager::getButtons public function Retrieves all available CKEditor buttons, keyed by plugin ID.
CKEditorPluginManager::getCssFiles public function Retrieves enabled plugins' iframe instance CSS files, keyed by plugin ID.
CKEditorPluginManager::getEnabledButtons public static function Gets the enabled toolbar buttons in the given text editor instance.
CKEditorPluginManager::getEnabledPluginFiles public function Retrieves enabled plugins' files, keyed by plugin ID.
CKEditorPluginManager::injectPluginSettingsForm public function Injects the CKEditor plugins settings forms as a vertical tabs subform.
CKEditorPluginManager::__construct public function Constructs a CKEditorPluginManager object. Overrides DefaultPluginManager::__construct
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional annotation namespaces.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults protected property A set of defaults to be referenced by $this->processDefinition(). 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object of root paths that are traversable.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 6
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery 13
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 14
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance public function 12
PluginManagerBase::getInstance public function 6
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.