function CKEditorPluginManagerTest::testEnabledPlugins in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/ckeditor/src/Tests/CKEditorPluginManagerTest.php \Drupal\ckeditor\Tests\CKEditorPluginManagerTest::testEnabledPlugins()

Tests the enabling of plugins.

File

core/modules/ckeditor/src/Tests/CKEditorPluginManagerTest.php, line 57

Contains \Drupal\ckeditor\Tests\CKEditorPluginManagerTest.

Class

CKEditorPluginManagerTest

Tests different ways of enabling CKEditor plugins.

Namespace

Drupal\ckeditor\Tests

Code

function testEnabledPlugins() {
  $this->manager = $this->container
    ->get('plugin.manager.ckeditor.plugin');
  $editor = entity_load('editor', 'filtered_html');

  // Case 1: no CKEditor plugins.
  $definitions = array_keys($this->manager
    ->getDefinitions());
  sort($definitions);
  $this
    ->assertIdentical(array(
    'drupalimage',
    'drupalimagecaption',
    'drupallink',
    'internal',
    'stylescombo',
  ), $definitions, 'No CKEditor plugins found besides the built-in ones.');
  $enabled_plugins = array(
    'drupalimage' => 'core/modules/ckeditor/js/plugins/drupalimage/plugin.js',
    'drupallink' => 'core/modules/ckeditor/js/plugins/drupallink/plugin.js',
  );
  $this
    ->assertIdentical($enabled_plugins, $this->manager
    ->getEnabledPluginFiles($editor), 'Only built-in plugins are enabled.');
  $this
    ->assertIdentical(array(
    'internal' => NULL,
  ) + $enabled_plugins, $this->manager
    ->getEnabledPluginFiles($editor, TRUE), 'Only the "internal" plugin is enabled.');

  // Enable the CKEditor Test module, which has the Llama plugin (plus three
  // variations of it, to cover all possible ways a plugin can be enabled) and
  // clear the editor manager's cache so it is picked up.
  $this
    ->enableModules(array(
    'ckeditor_test',
  ));
  $this->manager = $this->container
    ->get('plugin.manager.ckeditor.plugin');
  $this->manager
    ->clearCachedDefinitions();

  // Case 2: CKEditor plugins are available.
  $plugin_ids = array_keys($this->manager
    ->getDefinitions());
  sort($plugin_ids);
  $this
    ->assertIdentical(array(
    'drupalimage',
    'drupalimagecaption',
    'drupallink',
    'internal',
    'llama',
    'llama_button',
    'llama_contextual',
    'llama_contextual_and_button',
    'stylescombo',
  ), $plugin_ids, 'Additional CKEditor plugins found.');
  $this
    ->assertIdentical($enabled_plugins, $this->manager
    ->getEnabledPluginFiles($editor), 'Only the internal plugins are enabled.');
  $this
    ->assertIdentical(array(
    'internal' => NULL,
  ) + $enabled_plugins, $this->manager
    ->getEnabledPluginFiles($editor, TRUE), 'Only the "internal" plugin is enabled.');

  // Case 3: enable each of the newly available plugins, if possible:
  // a. Llama: cannot be enabled, since it does not implement
  //    CKEditorPluginContextualInterface nor CKEditorPluginButtonsInterface.
  // b. LlamaContextual: enabled by adding the 'Strike' button, which is
  //    part of another plugin!
  // c. LlamaButton: automatically enabled by adding its 'Llama' button.
  // d. LlamaContextualAndButton: enabled by either b or c.
  // Below, we will first enable the "Llama" button, which will cause the
  // LlamaButton and LlamaContextualAndButton plugins to be enabled. Then we
  // will remove the "Llama" button and add the "Strike" button, which will
  // cause the LlamaContextual and LlamaContextualAndButton plugins to be
  // enabled. Finally, we will add the "Strike" button back again, which would
  // cause all three plugins to be enabled.
  $settings = $editor
    ->getSettings();
  $original_toolbar = $settings['toolbar'];
  $settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
  $editor
    ->setSettings($settings);
  $editor
    ->save();
  $file = array();
  $file['b'] = 'core/modules/ckeditor/tests/modules/js/llama_button.js';
  $file['c'] = 'core/modules/ckeditor/tests/modules/js/llama_contextual.js';
  $file['cb'] = 'core/modules/ckeditor/tests/modules/js/llama_contextual_and_button.js';
  $expected = $enabled_plugins + array(
    'llama_button' => $file['b'],
    'llama_contextual_and_button' => $file['cb'],
  );
  $this
    ->assertIdentical($expected, $this->manager
    ->getEnabledPluginFiles($editor), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
  $this
    ->assertIdentical(array(
    'internal' => NULL,
  ) + $expected, $this->manager
    ->getEnabledPluginFiles($editor, TRUE), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
  $settings['toolbar'] = $original_toolbar;
  $settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
  $editor
    ->setSettings($settings);
  $editor
    ->save();
  $expected = $enabled_plugins + array(
    'llama_contextual' => $file['c'],
    'llama_contextual_and_button' => $file['cb'],
  );
  $this
    ->assertIdentical($expected, $this->manager
    ->getEnabledPluginFiles($editor), 'The  LLamaContextual and LlamaContextualAndButton plugins are enabled.');
  $this
    ->assertIdentical(array(
    'internal' => NULL,
  ) + $expected, $this->manager
    ->getEnabledPluginFiles($editor, TRUE), 'The LlamaContextual and LlamaContextualAndButton plugins are enabled.');
  $settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
  $editor
    ->setSettings($settings);
  $editor
    ->save();
  $expected = $enabled_plugins + array(
    'llama_button' => $file['b'],
    'llama_contextual' => $file['c'],
    'llama_contextual_and_button' => $file['cb'],
  );
  $this
    ->assertIdentical($expected, $this->manager
    ->getEnabledPluginFiles($editor), 'The LlamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
  $this
    ->assertIdentical(array(
    'internal' => NULL,
  ) + $expected, $this->manager
    ->getEnabledPluginFiles($editor, TRUE), 'The LLamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
}