CKEditorPluginManager.php 7.38 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php

/**
 * @file
 * Contains \Drupal\ckeditor\CKEditorPluginManager.
 */

namespace Drupal\ckeditor;

use Drupal\Component\Utility\NestedArray;
11
use Drupal\Core\Form\FormStateInterface;
12 13 14
use Drupal\Core\Plugin\DefaultPluginManager;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
15
use Drupal\editor\Entity\Editor;
16 17

/**
18 19 20 21 22 23 24 25 26
 * Provides a CKEditor Plugin plugin manager.
 *
 * @see \Drupal\ckeditor\CKEditorPluginInterface
 * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
 * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
 * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
 * @see \Drupal\ckeditor\CKEditorPluginBase
 * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
 * @see plugin_api
27
 */
28
class CKEditorPluginManager extends DefaultPluginManager {
29 30

  /**
31
   * Constructs a CKEditorPluginManager object.
32
   *
33 34
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
35 36 37 38 39
   *   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.
40
   */
41
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
42 43
    parent::__construct('Plugin/CKEditorPlugin', $namespaces, $module_handler, 'Drupal\ckeditor\Annotation\CKEditorPlugin');
    $this->alterInfo('ckeditor_plugin_info');
44
    $this->setCacheBackend($cache_backend, 'ckeditor_plugins');
45 46 47
  }

  /**
48
   * Retrieves enabled plugins' files, keyed by plugin ID.
49 50 51 52 53 54 55 56 57 58 59 60 61
   *
   * 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.
   *
62
   * @param \Drupal\editor\Entity\Editor $editor
63 64 65 66 67 68 69 70 71
   *   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.
   */
72
  public function getEnabledPluginFiles(Editor $editor, $include_internal_plugins = FALSE) {
73
    $plugins = array_keys($this->getDefinitions());
74 75
    // Flatten each row.
    $toolbar_rows = array();
76 77 78
    $settings = $editor->getSettings();
    foreach ($settings['toolbar']['rows'] as $row_number => $row) {
      $toolbar_rows[] = array_reduce($settings['toolbar']['rows'][$row_number], function (&$result, $button_group) {
79 80 81 82
        return array_merge($result, $button_group['items']);
      }, array());
    }
    $toolbar_buttons = array_unique(NestedArray::mergeDeepArray($toolbar_rows));
83
    $enabled_plugins = array();
84
    $additional_plugins = array();
85 86 87 88 89 90 91 92 93

    foreach ($plugins as $plugin_id) {
      $plugin = $this->createInstance($plugin_id);

      if (!$include_internal_plugins && $plugin->isInternal()) {
        continue;
      }

      $enabled = FALSE;
94
      // Enable this plugin if it provides a button that has been enabled.
95 96 97 98
      if ($plugin instanceof CKEditorPluginButtonsInterface) {
        $plugin_buttons = array_keys($plugin->getButtons());
        $enabled = (count(array_intersect($toolbar_buttons, $plugin_buttons)) > 0);
      }
99
      // Otherwise enable this plugin if it declares itself as enabled.
100 101 102 103 104 105
      if (!$enabled && $plugin instanceof CKEditorPluginContextualInterface) {
        $enabled = $plugin->isEnabled($editor);
      }

      if ($enabled) {
        $enabled_plugins[$plugin_id] = ($plugin->isInternal()) ? NULL : $plugin->getFile();
106 107
        // 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));
108 109 110
      }
    }

111 112 113 114 115 116
    // 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();
    }

117 118 119 120 121 122 123
    // Always return plugins in the same order.
    asort($enabled_plugins);

    return $enabled_plugins;
  }

  /**
124
   * Retrieves all available CKEditor buttons, keyed by plugin ID.
125 126
   *
   * @return array
127
   *   All available CKEditor buttons, with plugin IDs as keys and button
128
   *   metadata (as implemented by getButtons()) as values.
129 130 131
   *
   * @see CKEditorPluginButtonsInterface::getButtons()
   */
132
  public function getButtons() {
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    $plugins = array_keys($this->getDefinitions());
    $buttons_plugins = array();

    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.
151 152
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
153
   * @param \Drupal\editor\Entity\Editor $editor
154 155
   *   A configured text editor object.
   */
156
  public function injectPluginSettingsForm(array &$form, FormStateInterface $form_state, Editor $editor) {
157 158 159 160 161 162 163 164 165
    $definitions = $this->getDefinitions();

    foreach (array_keys($definitions) as $plugin_id) {
      $plugin = $this->createInstance($plugin_id);
      if ($plugin instanceof CKEditorPluginConfigurableInterface) {
        $plugin_settings_form = array();
        $form['plugins'][$plugin_id] = array(
          '#type' => 'details',
          '#title' => $definitions[$plugin_id]['label'],
166
          '#open' => TRUE,
167
          '#group' => 'editor][settings][plugin_settings',
168 169 170
          '#attributes' => array(
            'data-ckeditor-plugin-id' => $plugin_id,
          ),
171
        );
172 173 174 175 176 177 178 179 180
        // 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 and !$plugin instanceof CKEditorPluginContextualInterface) {
          $form['plugins'][$plugin_id]['#attributes']['data-ckeditor-buttons'] = implode(' ', array_keys($plugin->getButtons()));
        }
181 182 183 184 185
        $form['plugins'][$plugin_id] += $plugin->settingsForm($plugin_settings_form, $form_state, $editor);
      }
    }
  }
}