You are here

Home » API reference » Zircon Profile 8.0 » CKEditorTest.php

class CKEditorTest in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/ckeditor/src/Tests/CKEditorTest.php \Drupal\ckeditor\Tests\CKEditorTest

Tests for the 'CKEditor' text editor plugin.

@group ckeditor

Hierarchy

Expanded class hierarchy of CKEditorTest

File

core/modules/ckeditor/src/Tests/CKEditorTest.php, line 19
Contains \Drupal\ckeditor\Tests\CKEditorTest.

Namespace

Drupal\ckeditor\Tests
View source 
class CKEditorTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    '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.
    $this
      ->installSchema('system', 'url_alias');

    // Create text format, associate CKEditor.
    $filtered_html_format = entity_create('filter_format', array(
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => array(
        'filter_html' => array(
          'status' => 1,
          'settings' => array(
            'allowed_html' => '<h2 id> <h3> <h4> <h5> <h6> <p> <br> <strong> <a href hreflang>',
          ),
        ),
      ),
    ));
    $filtered_html_format
      ->save();
    $editor = entity_create('editor', array(
      '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().
   */
  function testGetJSSettings() {
    $editor = entity_load('editor', 'filtered_html');

    // Default toolbar.
    $expected_config = $this
      ->getDefaultInternalConfig() + array(
      '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' => array(
        'drupalimage' => file_create_url('core/modules/ckeditor/js/plugins/drupalimage/plugin.js'),
        'drupallink' => 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(array(
      '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_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual.js');
    $expected_config['drupalExternalPlugins']['llama_contextual_and_button'] = file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual_and_button.js');
    $expected_config['contentsCss'][] = file_create_url('core/modules/ckeditor/tests/modules/ckeditor_test.css');
    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'] = array(
      'attributes' => 'class',
      'styles' => FALSE,
      'classes' => TRUE,
    );
    $expected_config['allowedContent']['h1'] = array(
      'attributes' => FALSE,
      'styles' => FALSE,
      'classes' => FALSE,
    );
    $expected_config['allowedContent']['blockquote'] = array(
      'attributes' => 'class',
      'styles' => FALSE,
      'classes' => TRUE,
    );
    $expected_config['allowedContent']['address'] = array(
      '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', array(
      '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', array(
      'status' => 1,
      'settings' => array(
        'restrictions' => array(
          'allowed' => array(
            'p' => TRUE,
            'a' => array(
              'href' => TRUE,
              'rel' => array(
                'nofollow' => TRUE,
              ),
              'class' => array(
                'external' => TRUE,
              ),
              'target' => array(
                '_blank' => FALSE,
              ),
            ),
            'span' => array(
              'class' => array(
                'dodo' => FALSE,
              ),
              'property' => array(
                'dc:*' => TRUE,
              ),
              'rel' => array(
                'foaf:*' => FALSE,
              ),
              'style' => array(
                'underline' => FALSE,
                'color' => FALSE,
                'font-size' => TRUE,
              ),
            ),
            '*' => array(
              'style' => FALSE,
              'on*' => FALSE,
              'class' => array(
                'is-a-hipster-llama' => TRUE,
                'and-more' => TRUE,
              ),
              'data-*' => TRUE,
            ),
            'del' => FALSE,
          ),
        ),
      ),
    ));
    $format
      ->save();
    $expected_config['allowedContent'] = array(
      'p' => array(
        'attributes' => TRUE,
        'styles' => FALSE,
        'classes' => 'is-a-hipster-llama,and-more',
      ),
      'a' => array(
        'attributes' => 'href,rel,class,target',
        'styles' => FALSE,
        'classes' => 'external',
      ),
      'span' => array(
        'attributes' => 'class,property,rel,style',
        'styles' => 'font-size',
        'classes' => FALSE,
      ),
      '*' => array(
        'attributes' => 'class,data-*',
        'styles' => FALSE,
        'classes' => 'is-a-hipster-llama,and-more',
      ),
      'del' => array(
        'attributes' => FALSE,
        'styles' => FALSE,
        'classes' => FALSE,
      ),
    );
    $expected_config['disallowedContent'] = array(
      'span' => array(
        'styles' => 'underline,color',
        'classes' => 'dodo',
      ),
      '*' => array(
        '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().
   */
  function testBuildToolbarJSSetting() {
    $editor = entity_load('editor', '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(array(
      '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().
   */
  function testBuildContentsCssJSSetting() {
    $editor = entity_load('editor', 'filtered_html');

    // 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(array(
      'ckeditor_test',
    ));
    $expected[] = file_create_url('core/modules/ckeditor/tests/modules/ckeditor_test.css');
    $this
      ->assertIdentical($expected, $this->ckeditor
      ->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a hook_ckeditor_css_alter() implementation exists.');

    // Enable the Bartik theme, which specifies a CKEditor stylesheet.
    \Drupal::service('theme_handler')
      ->install([
      'bartik',
    ]);
    $this
      ->config('system.theme')
      ->set('default', 'bartik')
      ->save();
    $expected[] = file_create_url('core/themes/bartik/css/base/elements.css');
    $expected[] = file_create_url('core/themes/bartik/css/components/captions.css');
    $expected[] = file_create_url('core/themes/bartik/css/components/table.css');
    $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().
   */
  function testInternalGetConfig() {
    $editor = entity_load('editor', '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().
   */
  function testStylesComboGetConfig() {
    $editor = entity_load('editor', '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'] = array();
    $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'] = array(
      array(
        'name' => 'Title',
        'element' => 'h1',
        'attributes' => array(
          'class' => 'title',
        ),
      ),
      array(
        'name' => 'Callout',
        'element' => 'p',
        'attributes' => array(
          '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'] = array(
      array(
        '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.
   */
  function testLanguages() {

    // Get CKEditor supported language codes and spot-check.
    $this
      ->enableModules(array(
      'language',
    ));
    $this
      ->installConfig(array(
      '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.
   */
  function testJSTranslation() {
    $this
      ->enableModules(array(
      '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(array(
      '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 array(
      'customConfig' => '',
      'pasteFromWordPromptCleanup' => TRUE,
      'resize_dir' => 'vertical',
      'justifyClasses' => array(
        'text-align-left',
        'text-align-center',
        'text-align-right',
        'text-align-justify',
      ),
      'entities' => 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 array(
      '*' => array(
        'attributes' => 'on*',
      ),
    );
  }
  protected function getDefaultToolbarConfig() {
    return array(
      array(
        'name' => 'Formatting',
        'items' => array(
          'Bold',
          'Italic',
        ),
      ),
      array(
        'name' => 'Links',
        'items' => array(
          'DrupalLink',
          'DrupalUnlink',
        ),
      ),
      array(
        'name' => 'Lists',
        'items' => array(
          'BulletedList',
          'NumberedList',
        ),
      ),
      array(
        'name' => 'Media',
        'items' => array(
          'Blockquote',
          'DrupalImage',
        ),
      ),
      array(
        'name' => 'Tools',
        'items' => array(
          'Source',
        ),
      ),
      '/',
    );
  }
  protected function getDefaultContentsCssConfig() {
    return array(
      file_create_url('core/modules/ckeditor/css/ckeditor-iframe.css'),
      file_create_url('core/modules/system/css/components/align.module.css'),
    );
  }

}

Members

Namesort descending 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. 2
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::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 function Casts MarkupInterface objects into strings.
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 Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
CKEditorTest::testBuildContentsCssJSSetting function Tests CKEditor::buildContentsCssJSSetting().
CKEditorTest::testBuildToolbarJSSetting function Tests CKEditor::buildToolbarJSSetting().
CKEditorTest::testGetJSSettings function Tests CKEditor::getJSSettings().
CKEditorTest::testInternalGetConfig function Tests Internal::getConfig().
CKEditorTest::testJSTranslation function Tests that CKEditor plugins participate in JS translation.
CKEditorTest::testLanguages function Tests language list availability in CKEditor.
CKEditorTest::testStylesComboGetConfig function Tests StylesCombo::getConfig().
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
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.
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.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.