class CKEditorTest in Drupal 8

Same name and namespace in other branches

9 core/modules/ckeditor/tests/src/Kernel/CKEditorTest.php \Drupal\Tests\ckeditor\Kernel\CKEditorTest
10 core/modules/ckeditor/tests/src/Kernel/CKEditorTest.php \Drupal\Tests\ckeditor\Kernel\CKEditorTest

Tests for the 'CKEditor' text editor plugin.

@group ckeditor

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\ckeditor\Kernel\CKEditorTest

Expanded class hierarchy of CKEditorTest

File

core/modules/ckeditor/tests/src/Kernel/CKEditorTest.php, line 16

Namespace

Drupal\Tests\ckeditor\Kernel

View source

class CKEditorTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'system',
    'user',
    'filter',
    'editor',
    'ckeditor',
    'filter_test',
  ];

  /**
   * An instance of the "CKEditor" text editor plugin.
   *
   * @var \Drupal\ckeditor\Plugin\Editor\CKEditor
   */
  protected $ckeditor;

  /**
   * The Editor Plugin Manager.
   *
   * @var \Drupal\editor\Plugin\EditorManager;
   */
  protected $manager;
  protected function setUp() {
    parent::setUp();

    // Install the Filter module.
    // Create text format, associate CKEditor.
    $filtered_html_format = FilterFormat::create([
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => [
        'filter_html' => [
          'status' => 1,
          'settings' => [
            'allowed_html' => '<h2 id> <h3> <h4> <h5> <h6> <p> <br> <strong> <a href hreflang>',
          ],
        ],
      ],
    ]);
    $filtered_html_format
      ->save();
    $editor = Editor::create([
      'format' => 'filtered_html',
      'editor' => 'ckeditor',
    ]);
    $editor
      ->save();

    // Create "CKEditor" text editor plugin instance.
    $this->ckeditor = $this->container
      ->get('plugin.manager.editor')
      ->createInstance('ckeditor');
  }

  /**
   * Tests CKEditor::getJSSettings().
   */
  public function testGetJSSettings() {
    $editor = Editor::load('filtered_html');
    $query_string = '?0=';

    // Default toolbar.
    $expected_config = $this
      ->getDefaultInternalConfig() + [
      'drupalImage_dialogTitleAdd' => 'Insert Image',
      'drupalImage_dialogTitleEdit' => 'Edit Image',
      'drupalLink_dialogTitleAdd' => 'Add Link',
      'drupalLink_dialogTitleEdit' => 'Edit Link',
      'allowedContent' => $this
        ->getDefaultAllowedContentConfig(),
      'disallowedContent' => $this
        ->getDefaultDisallowedContentConfig(),
      'toolbar' => $this
        ->getDefaultToolbarConfig(),
      'contentsCss' => $this
        ->getDefaultContentsCssConfig(),
      'extraPlugins' => 'drupalimage,drupallink',
      'language' => 'en',
      'stylesSet' => FALSE,
      'drupalExternalPlugins' => [
        'drupalimage' => file_url_transform_relative(file_create_url('core/modules/ckeditor/js/plugins/drupalimage/plugin.js')),
        'drupallink' => file_url_transform_relative(file_create_url('core/modules/ckeditor/js/plugins/drupallink/plugin.js')),
      ],
    ];
    $expected_config = $this
      ->castSafeStrings($expected_config);
    ksort($expected_config);
    ksort($expected_config['allowedContent']);
    $this
      ->assertIdentical($expected_config, $this
      ->castSafeStrings($this->ckeditor
      ->getJSSettings($editor)), 'Generated JS settings are correct for default configuration.');

    // Customize the configuration: add button, have two contextually enabled
    // buttons, and configure a CKEditor plugin setting.
    $this
      ->enableModules([
      'ckeditor_test',
    ]);
    $this->container
      ->get('plugin.manager.editor')
      ->clearCachedDefinitions();
    $this->ckeditor = $this->container
      ->get('plugin.manager.editor')
      ->createInstance('ckeditor');
    $this->container
      ->get('plugin.manager.ckeditor.plugin')
      ->clearCachedDefinitions();
    $settings = $editor
      ->getSettings();
    $settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
    $settings['toolbar']['rows'][0][0]['items'][] = 'Format';
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected_config['toolbar'][0]['items'][] = 'Strike';
    $expected_config['toolbar'][0]['items'][] = 'Format';
    $expected_config['format_tags'] = 'p;h2;h3;h4;h5;h6';
    $expected_config['extraPlugins'] .= ',llama_contextual,llama_contextual_and_button';
    $expected_config['drupalExternalPlugins']['llama_contextual'] = file_url_transform_relative(file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual.js'));
    $expected_config['drupalExternalPlugins']['llama_contextual_and_button'] = file_url_transform_relative(file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual_and_button.js'));
    $expected_config['contentsCss'][] = file_url_transform_relative(file_create_url('core/modules/ckeditor/tests/modules/ckeditor_test.css')) . $query_string;
    ksort($expected_config);
    $this
      ->assertIdentical($expected_config, $this
      ->castSafeStrings($this->ckeditor
      ->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');

    // Change the allowed HTML tags; the "allowedContent" and "format_tags"
    // settings for CKEditor should automatically be updated as well.
    $format = $editor
      ->getFilterFormat();
    $format
      ->filters('filter_html')->settings['allowed_html'] .= '<pre class> <h1> <blockquote class="*"> <address class="foo bar-* *">';
    $format
      ->save();
    $expected_config['allowedContent']['pre'] = [
      'attributes' => 'class',
      'styles' => FALSE,
      'classes' => TRUE,
    ];
    $expected_config['allowedContent']['h1'] = [
      'attributes' => FALSE,
      'styles' => FALSE,
      'classes' => FALSE,
    ];
    $expected_config['allowedContent']['blockquote'] = [
      'attributes' => 'class',
      'styles' => FALSE,
      'classes' => TRUE,
    ];
    $expected_config['allowedContent']['address'] = [
      'attributes' => 'class',
      'styles' => FALSE,
      'classes' => 'foo,bar-*',
    ];
    $expected_config['format_tags'] = 'p;h1;h2;h3;h4;h5;h6;pre';
    ksort($expected_config['allowedContent']);
    $this
      ->assertIdentical($expected_config, $this
      ->castSafeStrings($this->ckeditor
      ->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');

    // Disable the filter_html filter: allow *all *tags.
    $format
      ->setFilterConfig('filter_html', [
      'status' => 0,
    ]);
    $format
      ->save();
    $expected_config['allowedContent'] = TRUE;
    $expected_config['disallowedContent'] = FALSE;
    $expected_config['format_tags'] = 'p;h1;h2;h3;h4;h5;h6;pre';
    $this
      ->assertIdentical($expected_config, $this
      ->castSafeStrings($this->ckeditor
      ->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');

    // Enable the filter_test_restrict_tags_and_attributes filter.
    $format
      ->setFilterConfig('filter_test_restrict_tags_and_attributes', [
      'status' => 1,
      'settings' => [
        'restrictions' => [
          'allowed' => [
            'p' => TRUE,
            'a' => [
              'href' => TRUE,
              'rel' => [
                'nofollow' => TRUE,
              ],
              'class' => [
                'external' => TRUE,
              ],
              'target' => [
                '_blank' => FALSE,
              ],
            ],
            'span' => [
              'class' => [
                'dodo' => FALSE,
              ],
              'property' => [
                'dc:*' => TRUE,
              ],
              'rel' => [
                'foaf:*' => FALSE,
              ],
              'style' => [
                'underline' => FALSE,
                'color' => FALSE,
                'font-size' => TRUE,
              ],
            ],
            '*' => [
              'style' => FALSE,
              'on*' => FALSE,
              'class' => [
                'is-a-hipster-llama' => TRUE,
                'and-more' => TRUE,
              ],
              'data-*' => TRUE,
            ],
            'del' => FALSE,
          ],
        ],
      ],
    ]);
    $format
      ->save();
    $expected_config['allowedContent'] = [
      'p' => [
        'attributes' => TRUE,
        'styles' => FALSE,
        'classes' => 'is-a-hipster-llama,and-more',
      ],
      'a' => [
        'attributes' => 'href,rel,class,target',
        'styles' => FALSE,
        'classes' => 'external',
      ],
      'span' => [
        'attributes' => 'class,property,rel,style',
        'styles' => 'font-size',
        'classes' => FALSE,
      ],
      '*' => [
        'attributes' => 'class,data-*',
        'styles' => FALSE,
        'classes' => 'is-a-hipster-llama,and-more',
      ],
      'del' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
    ];
    $expected_config['disallowedContent'] = [
      'span' => [
        'styles' => 'underline,color',
        'classes' => 'dodo',
      ],
      '*' => [
        'attributes' => 'on*',
      ],
    ];
    $expected_config['format_tags'] = 'p';
    ksort($expected_config);
    ksort($expected_config['allowedContent']);
    ksort($expected_config['disallowedContent']);
    $this
      ->assertIdentical($expected_config, $this
      ->castSafeStrings($this->ckeditor
      ->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');
  }

  /**
   * Tests CKEditor::buildToolbarJSSetting().
   */
  public function testBuildToolbarJSSetting() {
    $editor = Editor::load('filtered_html');

    // Default toolbar.
    $expected = $this
      ->getDefaultToolbarConfig();
    $this
      ->assertIdentical($expected, $this
      ->castSafeStrings($this->ckeditor
      ->buildToolbarJSSetting($editor)), '"toolbar" configuration part of JS settings built correctly for default toolbar.');

    // Customize the configuration.
    $settings = $editor
      ->getSettings();
    $settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected[0]['items'][] = 'Strike';
    $this
      ->assertIdentical($expected, $this
      ->castSafeStrings($this->ckeditor
      ->buildToolbarJSSetting($editor)), '"toolbar" configuration part of JS settings built correctly for customized toolbar.');

    // Enable the editor_test module, customize further.
    $this
      ->enableModules([
      'ckeditor_test',
    ]);
    $this->container
      ->get('plugin.manager.ckeditor.plugin')
      ->clearCachedDefinitions();

    // Override the label of a toolbar component.
    $settings['toolbar']['rows'][0][0]['name'] = 'JunkScience';
    $settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected[0]['name'] = 'JunkScience';
    $expected[0]['items'][] = 'Llama';
    $this
      ->assertIdentical($expected, $this
      ->castSafeStrings($this->ckeditor
      ->buildToolbarJSSetting($editor)), '"toolbar" configuration part of JS settings built correctly for customized toolbar with contrib module-provided CKEditor plugin.');
  }

  /**
   * Tests CKEditor::buildContentsCssJSSetting().
   */
  public function testBuildContentsCssJSSetting() {
    $editor = Editor::load('filtered_html');
    $query_string = '?0=';

    // Default toolbar.
    $expected = $this
      ->getDefaultContentsCssConfig();
    $this
      ->assertIdentical($expected, $this->ckeditor
      ->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly for default toolbar.');

    // Enable the editor_test module, which implements hook_ckeditor_css_alter().
    $this
      ->enableModules([
      'ckeditor_test',
    ]);
    $expected[] = file_url_transform_relative(file_create_url(drupal_get_path('module', 'ckeditor_test') . '/ckeditor_test.css')) . $query_string;
    $this
      ->assertIdentical($expected, $this->ckeditor
      ->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a hook_ckeditor_css_alter() implementation exists.');

    // Enable LlamaCss plugin, which adds an additional CKEditor stylesheet.
    $this->container
      ->get('plugin.manager.editor')
      ->clearCachedDefinitions();
    $this->ckeditor = $this->container
      ->get('plugin.manager.editor')
      ->createInstance('ckeditor');
    $this->container
      ->get('plugin.manager.ckeditor.plugin')
      ->clearCachedDefinitions();
    $settings = $editor
      ->getSettings();

    // LlamaCss: automatically enabled by adding its 'LlamaCSS' button.
    $settings['toolbar']['rows'][0][0]['items'][] = 'LlamaCSS';
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected[] = file_url_transform_relative(file_create_url(drupal_get_path('module', 'ckeditor_test') . '/css/llama.css')) . $query_string;
    $this
      ->assertIdentical($expected, $this->ckeditor
      ->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a CKEditorPluginInterface implementation exists.');

    // Enable the Bartik theme, which specifies a CKEditor stylesheet.
    \Drupal::service('theme_installer')
      ->install([
      'bartik',
    ]);
    $this
      ->config('system.theme')
      ->set('default', 'bartik')
      ->save();
    $expected[] = file_url_transform_relative(file_create_url('core/themes/classy/css/components/media-embed-error.css')) . $query_string;
    $expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/base/elements.css')) . $query_string;
    $expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/components/captions.css')) . $query_string;
    $expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/components/table.css')) . $query_string;
    $expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/components/text-formatted.css')) . $query_string;
    $expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/classy/components/media-embed-error.css')) . $query_string;
    $this
      ->assertIdentical($expected, $this->ckeditor
      ->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a theme providing a CKEditor stylesheet exists.');
  }

  /**
   * Tests Internal::getConfig().
   */
  public function testInternalGetConfig() {
    $editor = Editor::load('filtered_html');
    $internal_plugin = $this->container
      ->get('plugin.manager.ckeditor.plugin')
      ->createInstance('internal');

    // Default toolbar.
    $expected = $this
      ->getDefaultInternalConfig();
    $expected['disallowedContent'] = $this
      ->getDefaultDisallowedContentConfig();
    $expected['allowedContent'] = $this
      ->getDefaultAllowedContentConfig();
    $this
      ->assertEqual($expected, $internal_plugin
      ->getConfig($editor), '"Internal" plugin configuration built correctly for default toolbar.');

    // Format dropdown/button enabled: new setting should be present.
    $settings = $editor
      ->getSettings();
    $settings['toolbar']['rows'][0][0]['items'][] = 'Format';
    $editor
      ->setSettings($settings);
    $expected['format_tags'] = 'p;h2;h3;h4;h5;h6';
    $this
      ->assertEqual($expected, $internal_plugin
      ->getConfig($editor), '"Internal" plugin configuration built correctly for customized toolbar.');
  }

  /**
   * Tests StylesCombo::getConfig().
   */
  public function testStylesComboGetConfig() {
    $editor = Editor::load('filtered_html');
    $stylescombo_plugin = $this->container
      ->get('plugin.manager.ckeditor.plugin')
      ->createInstance('stylescombo');

    // Styles dropdown/button enabled: new setting should be present.
    $settings = $editor
      ->getSettings();
    $settings['toolbar']['rows'][0][0]['items'][] = 'Styles';
    $settings['plugins']['stylescombo']['styles'] = '';
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected['stylesSet'] = [];
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');

    // Configure the optional "styles" setting in odd ways that shouldn't affect
    // the end result.
    $settings['plugins']['stylescombo']['styles'] = "   \n";
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor));
    $settings['plugins']['stylescombo']['styles'] = "\r\n  \n  \r  \n ";
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');

    // Now configure it properly, the end result should change.
    $settings['plugins']['stylescombo']['styles'] = "h1.title|Title\np.mAgical.Callout|Callout";
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected['stylesSet'] = [
      [
        'name' => 'Title',
        'element' => 'h1',
        'attributes' => [
          'class' => 'title',
        ],
      ],
      [
        'name' => 'Callout',
        'element' => 'p',
        'attributes' => [
          'class' => 'mAgical Callout',
        ],
      ],
    ];
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');

    // Same configuration, but now interspersed with nonsense. Should yield the
    // same result.
    $settings['plugins']['stylescombo']['styles'] = "  h1 .title   |  Title \r \n\r  \np.mAgical  .Callout|Callout\r";
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');

    // Slightly different configuration: class names are optional.
    $settings['plugins']['stylescombo']['styles'] = "      h1 |  Title ";
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected['stylesSet'] = [
      [
        'name' => 'Title',
        'element' => 'h1',
      ],
    ];
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');

    // Invalid syntax should cause stylesSet to be set to FALSE.
    $settings['plugins']['stylescombo']['styles'] = "h1";
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $expected['stylesSet'] = FALSE;
    $this
      ->assertIdentical($expected, $stylescombo_plugin
      ->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
  }

  /**
   * Tests language list availability in CKEditor.
   */
  public function testLanguages() {

    // Get CKEditor supported language codes and spot-check.
    $this
      ->enableModules([
      'language',
    ]);
    $this
      ->installConfig([
      'language',
    ]);
    $langcodes = $this->ckeditor
      ->getLangcodes();

    // Language codes transformed with browser mappings.
    $this
      ->assertTrue($langcodes['pt-pt'] == 'pt', '"pt" properly resolved');
    $this
      ->assertTrue($langcodes['zh-hans'] == 'zh-cn', '"zh-hans" properly resolved');

    // Language code both in Drupal and CKEditor.
    $this
      ->assertTrue($langcodes['gl'] == 'gl', '"gl" properly resolved');

    // Language codes only in CKEditor.
    $this
      ->assertTrue($langcodes['en-au'] == 'en-au', '"en-au" properly resolved');
    $this
      ->assertTrue($langcodes['sr-latn'] == 'sr-latn', '"sr-latn" properly resolved');

    // No locale module, so even though languages are enabled, CKEditor should
    // still be in English.
    $this
      ->assertCKEditorLanguage('en');
  }

  /**
   * Tests that CKEditor plugins participate in JS translation.
   */
  public function testJSTranslation() {
    $this
      ->enableModules([
      'language',
      'locale',
    ]);
    $this
      ->installSchema('locale', 'locales_source');
    $this
      ->installSchema('locale', 'locales_location');
    $this
      ->installSchema('locale', 'locales_target');
    $editor = Editor::load('filtered_html');
    $this->ckeditor
      ->getJSSettings($editor);
    $localeStorage = $this->container
      ->get('locale.storage');
    $string = $localeStorage
      ->findString([
      'source' => 'Edit Link',
      'context' => '',
    ]);
    $this
      ->assertTrue(!empty($string), 'String from JavaScript file saved.');

    // With locale module, CKEditor should not adhere to the language selected.
    $this
      ->assertCKEditorLanguage();
  }

  /**
   * Assert that CKEditor picks the expected language when French is default.
   *
   * @param string $langcode
   *   Language code to assert for. Defaults to French. That is the default
   *   language set in this assertion.
   */
  protected function assertCKEditorLanguage($langcode = 'fr') {

    // Set French as the site default language.
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();
    $this
      ->config('system.site')
      ->set('default_langcode', 'fr')
      ->save();

    // Reset the language manager so new negotiations attempts will fall back on
    // French. Reinject the language manager CKEditor to use the current one.
    $this->container
      ->get('language_manager')
      ->reset();
    $this->ckeditor = $this->container
      ->get('plugin.manager.editor')
      ->createInstance('ckeditor');

    // Test that we now get the expected language.
    $editor = Editor::load('filtered_html');
    $settings = $this->ckeditor
      ->getJSSettings($editor);
    $this
      ->assertEqual($settings['language'], $langcode);
  }
  protected function getDefaultInternalConfig() {
    return [
      'customConfig' => '',
      'pasteFromWordPromptCleanup' => TRUE,
      'resize_dir' => 'vertical',
      'justifyClasses' => [
        'text-align-left',
        'text-align-center',
        'text-align-right',
        'text-align-justify',
      ],
      'entities' => FALSE,
      'disableNativeSpellChecker' => FALSE,
    ];
  }
  protected function getDefaultAllowedContentConfig() {
    return [
      'h2' => [
        'attributes' => 'id',
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'h3' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'h4' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'h5' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'h6' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'p' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'br' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'strong' => [
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      'a' => [
        'attributes' => 'href,hreflang',
        'styles' => FALSE,
        'classes' => FALSE,
      ],
      '*' => [
        'attributes' => 'lang,dir',
        'styles' => FALSE,
        'classes' => FALSE,
      ],
    ];
  }
  protected function getDefaultDisallowedContentConfig() {
    return [
      '*' => [
        'attributes' => 'on*',
      ],
    ];
  }
  protected function getDefaultToolbarConfig() {
    return [
      [
        'name' => 'Formatting',
        'items' => [
          'Bold',
          'Italic',
        ],
      ],
      [
        'name' => 'Links',
        'items' => [
          'DrupalLink',
          'DrupalUnlink',
        ],
      ],
      [
        'name' => 'Lists',
        'items' => [
          'BulletedList',
          'NumberedList',
        ],
      ],
      [
        'name' => 'Media',
        'items' => [
          'Blockquote',
          'DrupalImage',
        ],
      ],
      [
        'name' => 'Tools',
        'items' => [
          'Source',
        ],
      ],
      '/',
    ];
  }
  protected function getDefaultContentsCssConfig() {
    $query_string = '?0=';
    return [
      file_url_transform_relative(file_create_url('core/modules/ckeditor/css/ckeditor-iframe.css')) . $query_string,
      file_url_transform_relative(file_create_url('core/modules/system/css/components/align.module.css')) . $query_string,
    ];
  }

  /**
   * @deprecationMessage Calling CKEditor::__construct() without the $state argument is deprecated in drupal:8.8.0. The $state argument is required in drupal:9.0.0. See https://www.drupal.org/node/3075102.
   * @group legacy
   */
  public function testConstructorDeprecation() {
    $editor = new CKEditor([], 'test', [
      'provider' => 'test',
    ], $this->container
      ->get('plugin.manager.ckeditor.plugin'), $this->container
      ->get('module_handler'), $this->container
      ->get('language_manager'), $this->container
      ->get('renderer'));

    // Ensure the BC layer injects the correct object.
    $reflection_object = new \ReflectionObject($editor);
    $reflection_property = $reflection_object
      ->getProperty('state');
    $reflection_property
      ->setAccessible(TRUE);
    $this
      ->assertSame($reflection_property
      ->getValue($editor), $this->container
      ->get('state'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
CKEditorTest::$ckeditor	protected	property	An instance of the "CKEditor" text editor plugin.
CKEditorTest::$manager	protected	property	The Editor Plugin Manager.
CKEditorTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
CKEditorTest::assertCKEditorLanguage	protected	function	Assert that CKEditor picks the expected language when French is default.
CKEditorTest::getDefaultAllowedContentConfig	protected	function
CKEditorTest::getDefaultContentsCssConfig	protected	function
CKEditorTest::getDefaultDisallowedContentConfig	protected	function
CKEditorTest::getDefaultInternalConfig	protected	function
CKEditorTest::getDefaultToolbarConfig	protected	function
CKEditorTest::setUp	protected	function	Overrides KernelTestBase::setUp
CKEditorTest::testBuildContentsCssJSSetting	public	function	Tests CKEditor::buildContentsCssJSSetting().
CKEditorTest::testBuildToolbarJSSetting	public	function	Tests CKEditor::buildToolbarJSSetting().
CKEditorTest::testConstructorDeprecation	public	function	@deprecationMessage Calling CKEditor::__construct() without the $state argument is deprecated in drupal:8.8.0. The $state argument is required in drupal:9.0.0. See https://www.drupal.org/node/3075102. @group legacy
CKEditorTest::testGetJSSettings	public	function	Tests CKEditor::getJSSettings().
CKEditorTest::testInternalGetConfig	public	function	Tests Internal::getConfig().
CKEditorTest::testJSTranslation	public	function	Tests that CKEditor plugins participate in JS translation.
CKEditorTest::testLanguages	public	function	Tests language list availability in CKEditor.
CKEditorTest::testStylesComboGetConfig	public	function	Tests StylesCombo::getConfig().
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class CKEditorTest in Drupal 8

Hierarchy

File

Namespace

Members

API Navigation