class CKEditor5Test
Same name in this branch
- 9 core/modules/ckeditor5/tests/src/Unit/CKEditor5Test.php \Drupal\Tests\ckeditor5\Unit\CKEditor5Test
Same name in other branches
- 10 core/modules/ckeditor5/tests/src/Unit/CKEditor5Test.php \Drupal\Tests\ckeditor5\Unit\CKEditor5Test
- 10 core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5Test.php \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5Test
- 11.x core/modules/ckeditor5/tests/src/Unit/CKEditor5Test.php \Drupal\Tests\ckeditor5\Unit\CKEditor5Test
- 11.x core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5Test.php \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5Test
Tests for CKEditor 5.
@group ckeditor5 @internal
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\FunctionalTests\AssertLegacyTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase extends \Drupal\Tests\BrowserTestBase
- class \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5TestBase extends \Drupal\FunctionalJavascriptTests\WebDriverTestBase
- class \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5Test extends \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5TestBase uses \Drupal\Tests\TestFileCreationTrait, \Drupal\Tests\ckeditor5\Traits\CKEditor5TestTrait
- class \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5TestBase extends \Drupal\FunctionalJavascriptTests\WebDriverTestBase
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of CKEditor5Test
File
-
core/
modules/ ckeditor5/ tests/ src/ FunctionalJavascript/ CKEditor5Test.php, line 24
Namespace
Drupal\Tests\ckeditor5\FunctionalJavascriptView source
class CKEditor5Test extends CKEditor5TestBase {
use TestFileCreationTrait;
use CKEditor5TestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'media_library',
];
/**
* Tests configuring CKEditor 5 for existing content.
*/
public function testExistingContent() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
// Add a node with text rendered via the Plain Text format.
$this->drupalGet('node/add');
$page->fillField('title[0][value]', 'My test content');
$page->fillField('body[0][value]', '<p>This is test content</p>');
$page->pressButton('Save');
$assert_session->responseNotContains('<p>This is test content</p>');
$assert_session->responseContains('<p>This is test content</p>');
$this->addNewTextFormat($page, $assert_session);
// Change the node to use the new text format.
$this->drupalGet('node/1/edit');
// Confirm that the JavaScript that generates IE11 warnings loads.
$assert_session->elementExists('css', 'script[src*="ckeditor5/js/ie11.user.warnings.js"]');
$page->selectFieldOption('body[0][format]', 'ckeditor5');
$this->assertNotEmpty($assert_session->waitForText('Change text format?'));
$page->pressButton('Continue');
// Ensure the editor is loaded.
$this->assertNotEmpty($assert_session->waitForElement('css', '.ck-editor'));
$page->pressButton('Save');
// Assert that the HTML is rendered correctly.
$assert_session->responseContains('<p>This is test content</p>');
$assert_session->responseNotContains('<p>This is test content</p>');
}
/**
* Ensures that attribute values are encoded.
*/
public function testAttributeEncoding() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
FilterFormat::create([
'format' => 'ckeditor5',
'name' => 'CKEditor 5 with image upload',
'roles' => [
RoleInterface::AUTHENTICATED_ID,
],
])->save();
Editor::create([
'format' => 'ckeditor5',
'editor' => 'ckeditor5',
'settings' => [
'toolbar' => [
'items' => [
'drupalInsertImage',
],
],
'plugins' => [
'ckeditor5_imageResize' => [
'allow_resize' => FALSE,
],
],
],
'image_upload' => [
'status' => TRUE,
'scheme' => 'public',
'directory' => 'inline-images',
'max_size' => '',
],
])->save();
$this->assertSame([], array_map(function (ConstraintViolation $v) {
return (string) $v->getMessage();
}, iterator_to_array(CKEditor5::validatePair(Editor::load('ckeditor5'), FilterFormat::load('ckeditor5')))));
$this->drupalGet('node/add');
$this->waitForEditor();
$page->fillField('title[0][value]', 'My test content');
// Ensure that CKEditor 5 is focused.
$this->click('.ck-content');
$this->assertNotEmpty($image_upload_field = $page->find('css', '.ck-file-dialog-button input[type="file"]'));
$image = $this->getTestFiles('image')[0];
$image_upload_field->attachFile($this->container
->get('file_system')
->realpath($image->uri));
$assert_session->waitForElementVisible('css', '.ck-widget.image');
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '.ck-balloon-panel .ck-text-alternative-form'));
$alt_override_input = $page->find('css', '.ck-balloon-panel .ck-text-alternative-form input[type=text]');
$this->assertSame('', $alt_override_input->getValue());
$alt_override_input->setValue('</em> Kittens & llamas are cute');
$this->getBalloonButton('Save')
->click();
$page->pressButton('Save');
$uploaded_image = File::load(1);
$image_uuid = $uploaded_image->uuid();
$image_url = $this->container
->get('file_url_generator')
->generateString($uploaded_image->getFileUri());
$this->drupalGet('node/1');
$this->assertNotEmpty($assert_session->waitForElement('xpath', sprintf('//img[@alt="</em> Kittens & llamas are cute" and @data-entity-uuid="%s" and @data-entity-type="file"]', $image_uuid)));
// Drupal CKEditor 5 integrations overrides the CKEditor 5 HTML writer to
// escape ampersand characters (&) and the angle brackets (< and >). This is
// required because \Drupal\Component\Utility\Xss::filter fails to parse
// element attributes with unescaped entities in value.
// @see https://www.drupal.org/project/drupal/issues/3227831
$this->assertEquals(sprintf('<img data-entity-uuid="%s" data-entity-type="file" src="%s" alt="</em> Kittens & llamas are cute">', $image_uuid, $image_url), Node::load(1)->get('body')->value);
}
/**
* Test headings configuration.
*/
public function testHeadingsPlugin() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
$this->addNewTextFormat($page, $assert_session);
$this->drupalGet('admin/config/content/formats/manage/ckeditor5');
$this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', '<br> <p> <h2> <h3> <h4> <h5> <h6> <strong> <em>');
$this->drupalGet('node/add');
$this->assertNotEmpty($assert_session->waitForElement('css', '.ck-heading-dropdown button'));
$page->find('css', '.ck-heading-dropdown button')
->click();
// Get all the headings available in dropdown.
$headings_dropdown = $page->findAll('css', '.ck-heading-dropdown li .ck-button__label');
// Create array of available headings.
$available_headings = [];
foreach ($headings_dropdown as $item) {
$available_headings[] = $item->getText();
}
$this->assertSame([
'Paragraph',
'Heading 2',
'Heading 3',
'Heading 4',
'Heading 5',
'Heading 6',
], $available_headings);
$this->drupalGet('admin/config/content/formats/manage/ckeditor5');
$this->assertTrue($page->hasUncheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading1]'));
$page->checkField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading1]');
$assert_session->assertWaitOnAjaxRequest();
$this->assertTrue($page->hasCheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading1]'));
$this->assertTrue($page->hasCheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading2]'));
$page->uncheckField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading2]');
$assert_session->assertWaitOnAjaxRequest();
$this->assertTrue($page->hasUncheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading2]'));
$this->assertTrue($page->hasCheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading4]'));
$page->uncheckField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading4]');
$assert_session->assertWaitOnAjaxRequest();
$this->assertTrue($page->hasUncheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading4]'));
$this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', '<br> <p> <h1> <h3> <h5> <h6> <strong> <em>');
$this->assertTrue($page->hasUncheckedField('editor[settings][plugins][ckeditor5_heading][enabled_headings][heading4]'));
$page->pressButton('Save configuration');
$this->drupalGet('node/add');
$this->assertNotEmpty($assert_session->waitForElement('css', '.ck-heading-dropdown button'));
$page->find('css', '.ck-heading-dropdown button')
->click();
// Get all the headings available in dropdown.
$headings_dropdown = $page->findAll('css', '.ck-heading-dropdown li .ck-button__label');
// Create array of available headings.
$available_headings = [];
foreach ($headings_dropdown as $item) {
$available_headings[] = $item->getText();
}
$this->assertSame([
'Paragraph',
'Heading 1',
'Heading 3',
'Heading 5',
'Heading 6',
], $available_headings);
}
/**
* Test for plugin Language of parts.
*/
public function testLanguageOfPartsPlugin() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
$this->createNewTextFormat($page, $assert_session);
// Press arrow down key to add the button to the active toolbar.
$this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-item-textPartLanguage'));
$this->triggerKeyUp('.ckeditor5-toolbar-item-textPartLanguage', 'ArrowDown');
$assert_session->assertWaitOnAjaxRequest();
// The CKEditor 5 module should warn that `<span>` cannot be created.
$assert_session->waitForElement('css', '[role=alert][data-drupal-message-type="warning"]:contains("The Language plugin needs another plugin to create <span>, for it to be able to create the following attributes: <span lang dir>. Enable a plugin that supports creating this tag. If none exists, you can configure the Source Editing plugin to support it.")');
// Make `<span>` creatable.
$this->assertNotEmpty($assert_session->elementExists('css', '.ckeditor5-toolbar-item-sourceEditing'));
$this->triggerKeyUp('.ckeditor5-toolbar-item-sourceEditing', 'ArrowDown');
$assert_session->assertWaitOnAjaxRequest();
// The Source Editing plugin settings form should now be present and should
// have no allowed tags configured.
$page->clickLink('Source editing');
$this->assertNotNull($assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-editor-settings-plugins-ckeditor5-sourceediting-allowed-tags"]'));
$javascript = <<<JS
const allowedTags = document.querySelector('[data-drupal-selector="edit-editor-settings-plugins-ckeditor5-sourceediting-allowed-tags"]');
allowedTags.value = '<span>';
allowedTags.dispatchEvent(new Event('input'));
JS;
$this->getSession()
->executeScript($javascript);
// Dispatching an `input` event does not work in WebDriver. Enabling another
// toolbar item which has no associated HTML elements forces it.
$this->triggerKeyUp('.ckeditor5-toolbar-item-undo', 'ArrowDown');
$assert_session->assertWaitOnAjaxRequest();
// Confirm there are no longer any warnings.
$assert_session->waitForElementRemoved('css', '[data-drupal-messages] [role="alert"]');
// Test for "United Nations' official languages" option.
$languages = LanguageManager::getUnitedNationsLanguageList();
$this->languageOfPartsPluginTestHelper($page, $assert_session, $languages, "un");
// Test for "All 95 languages" option.
$this->drupalGet('admin/config/content/formats/manage/ckeditor5');
$languages = LanguageManager::getStandardLanguageList();
$this->languageOfPartsPluginTestHelper($page, $assert_session, $languages, "all");
}
/**
* Validate the available languages on the basis of selected language option.
*/
public function languageOfPartsPluginTestHelper($page, $assert_session, $predefined_languages, $option) {
$this->assertNotEmpty($assert_session->waitForElement('css', 'a[href^="#edit-editor-settings-plugins-ckeditor5-language"]'));
// Set correct value.
$vertical_tab_link = $page->find('xpath', "//ul[contains(@class, 'vertical-tabs__menu')]/li/a[starts-with(@href, '#edit-editor-settings-plugins-ckeditor5-language')]");
$vertical_tab_link->click();
$page->selectFieldOption('editor[settings][plugins][ckeditor5_language][language_list]', $option);
$assert_session->assertWaitOnAjaxRequest();
$page->pressButton('Save configuration');
// Validate plugin on node add page.
$this->drupalGet('node/add');
$this->assertNotEmpty($assert_session->waitForText('Choose language'));
// Click on the dropdown button.
$page->find('css', '.ck-text-fragment-language-dropdown button')
->click();
// Get all the languages available in dropdown.
$current_languages = $page->findAll('css', '.ck-text-fragment-language-dropdown li .ck-button__label');
// Remove "Remove language" element from current languages.
array_shift($current_languages);
// Create array of full language name.
$languages = [];
foreach ($current_languages as $item) {
$languages[] = $item->getText();
}
// Return the values from a single column.
$predefined_languages = array_column($predefined_languages, 0);
// Sort on full language name.
asort($predefined_languages);
$this->assertSame(array_values($predefined_languages), $languages);
}
/**
* Gets the titles of the vertical tabs in the given container.
*
* @param string $container_selector
* The container in which to look for vertical tabs.
* @param bool $visible_only
* (optional) Whether to restrict to only the visible vertical tabs. TRUE by
* default.
*
* @return string[]
* The titles of all vertical tabs menu items, restricted to only
* visible ones by default.
*
* @throws \LogicException
*/
private function getVerticalTabs(string $container_selector, bool $visible_only = TRUE) : array {
$page = $this->getSession()
->getPage();
// Ensure the container exists.
$container = $page->find('css', $container_selector);
if ($container === NULL) {
throw new \LogicException('The given container should exist.');
}
// Make sure that the container selector contains exactly one Vertical Tabs
// UI component.
$vertical_tabs = $container->findAll('css', '.vertical-tabs');
if (count($vertical_tabs) != 1) {
throw new \LogicException('The given container should contain exactly one Vertical Tabs component.');
}
$vertical_tabs = $container->findAll('css', '.vertical-tabs__menu-item');
$vertical_tabs_titles = [];
foreach ($vertical_tabs as $vertical_tab) {
if ($visible_only && !$vertical_tab->isVisible()) {
continue;
}
$title = $vertical_tab->find('css', '.vertical-tabs__menu-item-title')
->getHtml();
// When retrieving visible vertical tabs, mark the selected one.
if ($visible_only && $vertical_tab->hasClass('is-selected')) {
$title = "➡️{$title}";
}
$vertical_tabs_titles[] = $title;
}
return $vertical_tabs_titles;
}
/**
* Enables a disabled CKEditor 5 toolbar item.
*
* @param string $toolbar_item_id
* The toolbar item to enable.
*/
protected function enableDisabledToolbarItem(string $toolbar_item_id) : void {
$assert_session = $this->assertSession();
$assert_session->elementExists('css', ".ckeditor5-toolbar-disabled .ckeditor5-toolbar-item-{$toolbar_item_id}");
$this->triggerKeyUp(".ckeditor5-toolbar-item-{$toolbar_item_id}", 'ArrowDown');
$assert_session->elementNotExists('css', ".ckeditor5-toolbar-disabled .ckeditor5-toolbar-item-{$toolbar_item_id}");
$assert_session->elementExists('css', ".ckeditor5-toolbar-active .ckeditor5-toolbar-item-{$toolbar_item_id}");
}
/**
* Confirms active tab status is intact after AJAX refresh.
*/
public function testActiveTabsMaintained() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
$this->createNewTextFormat($page, $assert_session);
$assert_session->assertWaitOnAjaxRequest();
// Initial vertical tabs: 3 for filters, 1 for CKE5 plugins.
$this->assertSame([
'Limit allowed HTML tags and correct faulty HTML',
'Convert URLs into links',
'Embed media',
], $this->getVerticalTabs('#filter-settings-wrapper', FALSE));
$this->assertSame([
'Headings',
], $this->getVerticalTabs('#plugin-settings-wrapper', FALSE));
// Initial visible vertical tabs: 1 for filters, 1 for CKE5 plugins.
$this->assertSame([
'➡️Limit allowed HTML tags and correct faulty HTML',
], $this->getVerticalTabs('#filter-settings-wrapper'));
$this->assertSame([
'➡️Headings',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
// Enable media embed to make a second filter config vertical tab visible.
$this->assertTrue($page->hasUncheckedField('filters[media_embed][status]'));
$this->assertNull($assert_session->waitForElementVisible('css', '[data-drupal-selector=edit-filters-media-embed-settings]', 0));
$page->checkField('filters[media_embed][status]');
$this->assertNotNull($assert_session->waitForElementVisible('css', '[data-drupal-selector=edit-filters-media-embed-settings]', 0));
$assert_session->assertWaitOnAjaxRequest();
// Filter plugins vertical tabs behavior: the filter plugin settings
// vertical tab with the heaviest filter weight is active by default.
// Hence enabling the media_embed filter (weight 100) results in its
// vertical tab being activated (filter_html's weight is -10).
// @see core/modules/filter/filter.admin.js
$this->assertSame([
'Limit allowed HTML tags and correct faulty HTML',
'➡️Embed media',
], $this->getVerticalTabs('#filter-settings-wrapper'));
$this->assertSame([
'➡️Headings',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
// Enable upload image to add a third (and fourth) CKE5 plugin vertical tab.
$this->enableDisabledToolbarItem('drupalInsertImage');
$assert_session->assertWaitOnAjaxRequest();
// The active CKE5 plugin settings vertical tab is unchanged.
$this->assertSame([
'➡️Headings',
'Image',
'Image resize',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
// The active filter plugin settings vertical tab is unchanged.
$this->assertSame([
'Limit allowed HTML tags and correct faulty HTML',
'➡️Embed media',
], $this->getVerticalTabs('#filter-settings-wrapper'));
// Open the CKE5 "Image" plugin settings vertical tab, interact with the
// subform and observe that the AJAX requests those interactions trigger do
// not change the active vertical tabs.
$page->clickLink('Image');
$assert_session->waitForText('Enable image uploads');
$this->assertSame([
'Headings',
'➡️Image',
'Image resize',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
$this->assertTrue($page->hasUncheckedField('editor[settings][plugins][ckeditor5_image][status]'));
$page->checkField('editor[settings][plugins][ckeditor5_image][status]');
$assert_session->assertWaitOnAjaxRequest();
$this->assertSame([
'Headings',
'➡️Image',
'Image resize',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
$this->assertSame([
'Limit allowed HTML tags and correct faulty HTML',
'➡️Embed media',
], $this->getVerticalTabs('#filter-settings-wrapper'));
$page->pressButton('Save configuration');
$assert_session->pageTextContains('Added text format ckeditor5');
// Leave and return to the config form, wait for initialized Vertical Tabs.
$this->drupalGet('admin/config/content/formats/');
$this->drupalGet('admin/config/content/formats/manage/ckeditor5');
$assert_session->waitForElement('css', '.vertical-tabs__menu-item.is-selected');
// The first CKE5 plugin settings vertical tab is active by default.
$this->assertSame([
'➡️Headings',
'Image',
'Image resize',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
// Filter plugins vertical tabs behavior: the filter plugin settings
// vertical tab with the heaviest filter weight is active by default.
// Hence enabling the media_embed filter (weight 100) results in its
// vertical tab being activated (filter_html's weight is -10).
// @see core/modules/filter/filter.admin.js
$this->assertSame([
'Limit allowed HTML tags and correct faulty HTML',
'➡️Embed media',
], $this->getVerticalTabs('#filter-settings-wrapper'));
// Click the 3rd CKE5 plugin vertical tab.
$page->clickLink($this->getVerticalTabs('#plugin-settings-wrapper')[2]);
$this->assertSame([
'Headings',
'Image',
'➡️Image resize',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
// Add another CKEditor 5 toolbar item just to trigger an AJAX refresh.
$this->enableDisabledToolbarItem('blockQuote');
$assert_session->assertWaitOnAjaxRequest();
// The active CKE5 plugin settings vertical tab is unchanged.
$this->assertSame([
'Headings',
'Image',
'➡️Image resize',
'Media',
], $this->getVerticalTabs('#plugin-settings-wrapper'));
// The active filter plugin settings vertical tab is unchanged.
$this->assertSame([
'Limit allowed HTML tags and correct faulty HTML',
'➡️Embed media',
], $this->getVerticalTabs('#filter-settings-wrapper'));
}
/**
* Ensures that CKEditor 5 integrates with file reference filter.
*/
public function testEditorFileReferenceIntegration() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
$this->createNewTextFormat($page, $assert_session);
$this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-item-drupalInsertImage'));
$this->triggerKeyUp('.ckeditor5-toolbar-item-drupalInsertImage', 'ArrowDown');
$assert_session->assertWaitOnAjaxRequest();
$page->clickLink('Image');
$page->checkField('editor[settings][plugins][ckeditor5_image][status]');
$assert_session->assertWaitOnAjaxRequest();
$page->checkField('filters[editor_file_reference][status]');
$assert_session->assertWaitOnAjaxRequest();
$this->saveNewTextFormat($page, $assert_session);
$this->drupalGet('node/add');
$page->fillField('title[0][value]', 'My test content');
// Ensure that CKEditor 5 is focused.
$this->click('.ck-content');
$this->assertNotEmpty($image_upload_field = $page->find('css', '.ck-file-dialog-button input[type="file"]'));
$image = $this->getTestFiles('image')[0];
$image_upload_field->attachFile($this->container
->get('file_system')
->realpath($image->uri));
// Wait until preview for the image has rendered to ensure that the image
// upload has completed and the image has been downcast.
// @see https://www.drupal.org/project/drupal/issues/3250587
$this->assertNotEmpty($assert_session->waitForElement('css', '.ck-content img[data-entity-uuid]'));
// Add alt text to the image.
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '.image.ck-widget > img'));
$this->assertNotEmpty($assert_session->waitForElementVisible('css', '.ck-balloon-panel .ck-text-alternative-form'));
$alt_override_input = $page->find('css', '.ck-balloon-panel .ck-text-alternative-form input[type=text]');
$alt_override_input->setValue('There is now alt text');
$this->getBalloonButton('Save')
->click();
$page->pressButton('Save');
$uploaded_image = File::load(1);
$image_url = $this->container
->get('file_url_generator')
->generateString($uploaded_image->getFileUri());
$image_uuid = $uploaded_image->uuid();
$assert_session->elementExists('xpath', sprintf('//img[@src="%s" and @loading="lazy" and @width and @height and @data-entity-uuid="%s" and @data-entity-type="file"]', $image_url, $image_uuid));
// Ensure that width, height, and length attributes are not stored in the
// database.
$this->assertEquals(sprintf('<img data-entity-uuid="%s" data-entity-type="file" src="%s" alt="There is now alt text">', $image_uuid, $image_url), Node::load(1)->get('body')->value);
// Ensure that data-entity-uuid and data-entity-type attributes are upcasted
// correctly to CKEditor model.
$this->drupalGet('node/1/edit');
$this->assertNotEmpty($assert_session->waitForElement('css', '.ck-editor'));
$page->pressButton('Save');
$assert_session->elementExists('xpath', sprintf('//img[@src="%s" and @loading="lazy" and @width and @height and @data-entity-uuid="%s" and @data-entity-type="file"]', $image_url, $image_uuid));
}
/**
* Ensures that CKEditor italic model is converted to em.
*/
public function testEmphasis() {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
// Add a node with text rendered via the Plain Text format.
$this->drupalGet('node/add');
$page->fillField('title[0][value]', 'My test content');
$page->fillField('body[0][value]', '<p>This is a <em>test!</em></p>');
$page->pressButton('Save');
$this->createNewTextFormat($page, $assert_session);
$this->saveNewTextFormat($page, $assert_session);
$this->drupalGet('node/1/edit');
$page->selectFieldOption('body[0][format]', 'ckeditor5');
$this->assertNotEmpty($assert_session->waitForText('Change text format?'));
$page->pressButton('Continue');
$this->assertNotEmpty($assert_session->waitForElement('css', '.ck-editor'));
$page->pressButton('Save');
$assert_session->responseContains('<p>This is a <em>test!</em></p>');
}
/**
* Tests list plugin.
*/
public function testListPlugin() {
FilterFormat::create([
'format' => 'test_format',
'name' => 'CKEditor 5 with list',
'roles' => [
RoleInterface::AUTHENTICATED_ID,
],
])->save();
Editor::create([
'format' => 'test_format',
'editor' => 'ckeditor5',
'settings' => [
'toolbar' => [
'items' => [
'sourceEditing',
'numberedList',
],
],
'plugins' => [
'ckeditor5_list' => [
'reversed' => FALSE,
'startIndex' => FALSE,
],
'ckeditor5_sourceEditing' => [
'allowed_tags' => [],
],
],
],
])->save();
$this->assertSame([], array_map(function (ConstraintViolation $v) {
return (string) $v->getMessage();
}, iterator_to_array(CKEditor5::validatePair(Editor::load('test_format'), FilterFormat::load('test_format')))));
$ordered_list_html = '<ol><li>apple</li><li>banana</li><li>cantaloupe</li></ol>';
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
$this->drupalGet('node/add');
$page->fillField('title[0][value]', 'My test content');
$this->pressEditorButton('Source');
$source_text_area = $assert_session->waitForElement('css', '.ck-source-editing-area textarea');
$source_text_area->setValue($ordered_list_html);
// Click source again to make source inactive and have the numbered list
// splitbutton active.
$this->pressEditorButton('Source');
$numbered_list_dropdown_selector = '.ck-splitbutton__arrow';
// Check that there is no dropdown available for the numbered list because
// both reversed and startIndex are FALSE.
$assert_session->elementNotExists('css', $numbered_list_dropdown_selector);
// Save content so source content is kept after changing the editor config.
$page->pressButton('Save');
$edit_url = $this->getSession()
->getCurrentURL() . '/edit';
$this->drupalGet($edit_url);
$this->waitForEditor();
// Enable the reversed functionality.
$editor = Editor::load('test_format');
$settings = $editor->getSettings();
$settings['plugins']['ckeditor5_list']['reversed'] = TRUE;
$editor->setSettings($settings);
$editor->save();
$this->getSession()
->reload();
$this->waitForEditor();
$this->click($numbered_list_dropdown_selector);
$reversed_order_button_selector = '.ck.ck-button.ck-numbered-list-properties__reversed-order';
$assert_session->elementExists('css', $reversed_order_button_selector);
$assert_session->elementTextEquals('css', $reversed_order_button_selector, 'Reversed order');
$start_index_element_selector = '.ck.ck-numbered-list-properties__start-index';
$assert_session->elementNotExists('css', $start_index_element_selector);
// Have both the reversed and the start index enabled.
$editor = Editor::load('test_format');
$settings = $editor->getSettings();
$settings['plugins']['ckeditor5_list']['startIndex'] = TRUE;
$editor->setSettings($settings);
$editor->save();
$this->getSession()
->reload();
$this->waitForEditor();
$this->click($numbered_list_dropdown_selector);
$assert_session->elementExists('css', $reversed_order_button_selector);
$assert_session->elementTextEquals('css', $reversed_order_button_selector, 'Reversed order');
$assert_session->elementExists('css', $start_index_element_selector);
}
/**
* Ensures that CKEditor 5 retains filter_html's allowed global attributes.
*
* FilterHtml always forbids the `style` and `on*` attributes, and always
* allows the `lang` attribute (with any value) and the `dir` attribute (with
* either `ltr` or `rtl` as value). It's important that those last two
* attributes are guaranteed to be retained.
*
* @see \Drupal\filter\Plugin\Filter\FilterHtml::getHTMLRestrictions()
* @see ckeditor5_globalAttributeDir
* @see ckeditor5_globalAttributeLang
* @see https://html.spec.whatwg.org/multipage/dom.html#global-attributes
*/
public function testFilterHtmlAllowedGlobalAttributes() : void {
$page = $this->getSession()
->getPage();
$assert_session = $this->assertSession();
// Add a node with text rendered via the Plain Text format.
$this->drupalGet('node/add');
$page->fillField('title[0][value]', 'Multilingual Hello World');
// cSpell:disable-next-line
$page->fillField('body[0][value]', '<p dir="ltr" lang="en">Hello World</p><p dir="rtl" lang="ar">مرحبا بالعالم</p>');
$page->pressButton('Save');
$this->createNewTextFormat($page, $assert_session);
$this->saveNewTextFormat($page, $assert_session);
$this->drupalGet('node/1/edit');
$page->selectFieldOption('body[0][format]', 'ckeditor5');
$this->assertNotEmpty($assert_session->waitForText('Change text format?'));
$page->pressButton('Continue');
$this->waitForEditor();
$page->pressButton('Save');
// @todo Remove the expected `xml:lang` attributes in https://www.drupal.org/project/drupal/issues/1333730
// cSpell:disable-next-line
$assert_session->responseContains('<p dir="ltr" lang="en" xml:lang="en">Hello World</p><p dir="rtl" lang="ar" xml:lang="ar">مرحبا بالعالم</p>');
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
AssertLegacyTrait::assert | Deprecated | protected | function | ||||
AssertLegacyTrait::assertCacheTag | Deprecated | protected | function | Asserts whether an expected cache tag was present in the last response. | |||
AssertLegacyTrait::assertElementNotPresent | Deprecated | protected | function | Asserts that the element with the given CSS selector is not present. | |||
AssertLegacyTrait::assertElementPresent | Deprecated | protected | function | Asserts that the element with the given CSS selector is present. | |||
AssertLegacyTrait::assertEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertEscaped | Deprecated | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertField | Deprecated | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertLegacyTrait::assertFieldById | Deprecated | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertLegacyTrait::assertFieldByName | Deprecated | protected | function | Asserts that a field exists with the given name and value. | |||
AssertLegacyTrait::assertFieldByXPath | Deprecated | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertLegacyTrait::assertFieldChecked | Deprecated | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertLegacyTrait::assertFieldsByValue | Deprecated | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertLegacyTrait::assertHeader | Deprecated | protected | function | Checks that current response header equals value. | |||
AssertLegacyTrait::assertIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | ||||
AssertLegacyTrait::assertLink | Deprecated | protected | function | Passes if a link with the specified label is found. | |||
AssertLegacyTrait::assertLinkByHref | Deprecated | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertLegacyTrait::assertNoCacheTag | Deprecated | protected | function | Asserts whether an expected cache tag was absent in the last response. | |||
AssertLegacyTrait::assertNoEscaped | Deprecated | protected | function | Passes if the raw text is not found escaped on the loaded page. | |||
AssertLegacyTrait::assertNoField | Deprecated | protected | function | Asserts that a field does NOT exist with the given name or ID. | |||
AssertLegacyTrait::assertNoFieldById | Deprecated | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertLegacyTrait::assertNoFieldByName | Deprecated | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertLegacyTrait::assertNoFieldByXPath | Deprecated | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertLegacyTrait::assertNoFieldChecked | Deprecated | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertLegacyTrait::assertNoLink | Deprecated | protected | function | Passes if a link with the specified label is not found. | |||
AssertLegacyTrait::assertNoLinkByHref | Deprecated | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertLegacyTrait::assertNoOption | Deprecated | protected | function | Asserts that a select option does NOT exist in the current page. | |||
AssertLegacyTrait::assertNoPattern | Deprecated | protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |||
AssertLegacyTrait::assertNoRaw | Deprecated | protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNoText | Deprecated | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNoUniqueText | Deprecated | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertLegacyTrait::assertOption | Deprecated | protected | function | Asserts that a select option in the current page exists. | |||
AssertLegacyTrait::assertOptionByText | Deprecated | protected | function | Asserts that a select option with the visible text exists. | |||
AssertLegacyTrait::assertOptionSelected | Deprecated | protected | function | Asserts that a select option in the current page is checked. | |||
AssertLegacyTrait::assertPattern | Deprecated | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertLegacyTrait::assertRaw | Deprecated | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertResponse | Deprecated | protected | function | Asserts the page responds with the specified response code. | |||
AssertLegacyTrait::assertText | Deprecated | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertLegacyTrait::assertTextHelper | Deprecated | protected | function | Helper for assertText and assertNoText. | |||
AssertLegacyTrait::assertTitle | Deprecated | protected | function | Pass if the page title is the given string. | |||
AssertLegacyTrait::assertUniqueText | Deprecated | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertLegacyTrait::assertUrl | Deprecated | protected | function | Passes if the internal browser's URL matches the given path. | |||
AssertLegacyTrait::buildXPathQuery | Deprecated | protected | function | Builds an XPath query. | |||
AssertLegacyTrait::constructFieldXpath | Deprecated | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertLegacyTrait::getAllOptions | Deprecated | protected | function | Get all option elements, including nested options, in a select. | |||
AssertLegacyTrait::getRawContent | Deprecated | protected | function | Gets the current raw content. | |||
AssertLegacyTrait::pass | Deprecated | protected | function | ||||
AssertLegacyTrait::verbose | Deprecated | protected | function | ||||
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | Aliased as: drupalPlaceBlock | |||
BrowserHtmlDebugTrait::$htmlOutputBaseUrl | protected | property | The Base URI to use for links to the output files. | ||||
BrowserHtmlDebugTrait::$htmlOutputClassName | protected | property | Class name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounter | protected | property | Counter for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounterStorage | protected | property | Counter storage for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputDirectory | protected | property | Directory name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputEnabled | protected | property | HTML output enabled. | ||||
BrowserHtmlDebugTrait::$htmlOutputFile | protected | property | The file name to write the list of URLs to. | ||||
BrowserHtmlDebugTrait::$htmlOutputTestId | protected | property | HTML output test ID. | ||||
BrowserHtmlDebugTrait::formatHtmlOutputHeaders | protected | function | Formats HTTP headers as string for HTML output logging. | ||||
BrowserHtmlDebugTrait::getResponseLogHandler | protected | function | Provides a Guzzle middleware handler to log every response received. | ||||
BrowserHtmlDebugTrait::htmlOutput | protected | function | Logs a HTML output message in a text file. | ||||
BrowserHtmlDebugTrait::initBrowserOutputFile | protected | function | Creates the directory to store browser output. | ||||
BrowserTestBase::$baseUrl | protected | property | The base URL. | ||||
BrowserTestBase::$configImporter | protected | property | The config importer that can be used in a test. | ||||
BrowserTestBase::$customTranslations | protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | ||||
BrowserTestBase::$mink | protected | property | Mink session manager. | ||||
BrowserTestBase::$minkDefaultDriverArgs | protected | property | Mink default driver params. | ||||
BrowserTestBase::$originalContainer | protected | property | The original container. | ||||
BrowserTestBase::$originalShutdownCallbacks | protected | property | The original array of shutdown function callbacks. | ||||
BrowserTestBase::$preserveGlobalState | protected | property | |||||
BrowserTestBase::$profile | protected | property | The profile to install as a basis for testing. | 37 | |||
BrowserTestBase::$runTestInSeparateProcess | protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. |
||||
BrowserTestBase::$timeLimit | protected | property | Time limit in seconds for the test. | ||||
BrowserTestBase::$translationFilesDirectory | protected | property | The translation file directory for the test environment. | ||||
BrowserTestBase::cleanupEnvironment | protected | function | Clean up the Simpletest environment. | ||||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
BrowserTestBase::drupalGetHeader | Deprecated | protected | function | Gets the value of an HTTP response header. | |||
BrowserTestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | ||||
BrowserTestBase::getDefaultDriverInstance | protected | function | Gets an instance of the default Mink driver. | ||||
BrowserTestBase::getHttpClient | protected | function | Obtain the HTTP client for the system under test. | ||||
BrowserTestBase::getOptions | protected | function | Helper function to get the options of select field. | ||||
BrowserTestBase::getSession | public | function | Returns Mink session. | ||||
BrowserTestBase::getSessionCookies | protected | function | Get session cookies from current session. | ||||
BrowserTestBase::getTestMethodCaller | protected | function | Retrieves the current calling line in the class under test. | Overrides BrowserHtmlDebugTrait::getTestMethodCaller | |||
BrowserTestBase::installDrupal | public | function | Installs Drupal into the Simpletest site. | 1 | |||
BrowserTestBase::registerSessions | protected | function | Registers additional Mink sessions. | ||||
BrowserTestBase::setUpAppRoot | protected | function | Sets up the root application path. | ||||
BrowserTestBase::setUpBeforeClass | public static | function | 1 | ||||
BrowserTestBase::translatePostValues | protected | function | Transforms a nested array into a flat array suitable for submitForm(). | ||||
BrowserTestBase::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | ||||
BrowserTestBase::__sleep | public | function | Prevents serializing any properties. | ||||
CKEditor5Test::$modules | protected static | property | Modules to enable. | Overrides CKEditor5TestBase::$modules | |||
CKEditor5Test::enableDisabledToolbarItem | protected | function | Enables a disabled CKEditor 5 toolbar item. | ||||
CKEditor5Test::getVerticalTabs | private | function | Gets the titles of the vertical tabs in the given container. | ||||
CKEditor5Test::languageOfPartsPluginTestHelper | public | function | Validate the available languages on the basis of selected language option. | ||||
CKEditor5Test::testActiveTabsMaintained | public | function | Confirms active tab status is intact after AJAX refresh. | ||||
CKEditor5Test::testAttributeEncoding | public | function | Ensures that attribute values are encoded. | ||||
CKEditor5Test::testEditorFileReferenceIntegration | public | function | Ensures that CKEditor 5 integrates with file reference filter. | ||||
CKEditor5Test::testEmphasis | public | function | Ensures that CKEditor italic model is converted to em. | ||||
CKEditor5Test::testExistingContent | public | function | Tests configuring CKEditor 5 for existing content. | ||||
CKEditor5Test::testFilterHtmlAllowedGlobalAttributes | public | function | Ensures that CKEditor 5 retains filter_html's allowed global attributes. | ||||
CKEditor5Test::testHeadingsPlugin | public | function | Test headings configuration. | ||||
CKEditor5Test::testLanguageOfPartsPlugin | public | function | Test for plugin Language of parts. | ||||
CKEditor5Test::testListPlugin | public | function | Tests list plugin. | ||||
CKEditor5TestBase::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | 3 | ||
CKEditor5TestBase::addNewTextFormat | public | function | Add and save a new text format using CKEditor 5. | ||||
CKEditor5TestBase::assertHtmlEsqueFieldValueEquals | protected | function | Decorates ::fieldValueEquals() to force DrupalCI to provide useful errors. | ||||
CKEditor5TestBase::assertNoRealtimeValidationErrors | protected | function | Checks that no real-time validation errors are present. | ||||
CKEditor5TestBase::createNewTextFormat | public | function | Create a new text format using CKEditor 5. | ||||
CKEditor5TestBase::saveNewTextFormat | public | function | Save the new text format. | ||||
CKEditor5TestBase::setUp | protected | function | Overrides BrowserTestBase::setUp | 7 | |||
CKEditor5TestBase::triggerKeyUp | protected | function | Trigger a keyup event on the selected element. | ||||
CKEditor5TestTrait::assertEditorButtonDisabled | protected | function | Asserts a CKEditor button is disabled. | ||||
CKEditor5TestTrait::assertEditorButtonEnabled | protected | function | Asserts a CKEditor button is enabled. | ||||
CKEditor5TestTrait::assertVisibleBalloon | protected | function | Asserts a particular balloon is visible. | ||||
CKEditor5TestTrait::getBalloonButton | protected | function | Gets a button from the currently visible balloon. | ||||
CKEditor5TestTrait::getEditorButton | protected | function | Waits for a CKEditor button and returns it when available and visible. | ||||
CKEditor5TestTrait::getEditorDataAsDom | protected | function | Gets CKEditor 5 instance data as a PHP DOMDocument. | ||||
CKEditor5TestTrait::getEditorDataAsHtmlString | protected | function | Gets CKEditor 5 instance data as a HTML string. | ||||
CKEditor5TestTrait::pressEditorButton | protected | function | Clicks a CKEditor button. | ||||
CKEditor5TestTrait::selectTextInsideElement | protected | function | Selects text inside an element. | ||||
CKEditor5TestTrait::waitForEditor | protected | function | Waits for CKEditor to initialize. | ||||
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. | ||||
ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||||
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | |||
FunctionalTestSetupTrait::$classLoader | protected | property | The class loader to use for installation and initialization of setup. | ||||
FunctionalTestSetupTrait::$rootUser | protected | property | The "#1" admin user. | ||||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 1 | |||
FunctionalTestSetupTrait::getDatabaseTypes | protected | function | Returns all supported database driver installer objects. | ||||
FunctionalTestSetupTrait::initConfig | protected | function | Initialize various configurations post-installation. | 1 | |||
FunctionalTestSetupTrait::initKernel | protected | function | Initializes the kernel after installation. | ||||
FunctionalTestSetupTrait::initSettings | protected | function | Initialize settings created during install. | ||||
FunctionalTestSetupTrait::initUserSession | protected | function | Initializes user 1 for the site to be installed. | ||||
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty | protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | ||||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 8 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 22 | |||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | ||||
FunctionalTestSetupTrait::prepareSettings | protected | function | Prepares site settings and services before installation. | 3 | |||
FunctionalTestSetupTrait::rebuildAll | protected | function | Resets and rebuilds the environment after setup. | ||||
FunctionalTestSetupTrait::rebuildContainer | protected | function | Rebuilds \Drupal::getContainer(). | ||||
FunctionalTestSetupTrait::resetAll | protected | function | Resets all data structures after having enabled new modules. | ||||
FunctionalTestSetupTrait::setContainerParameter | protected | function | Changes parameters in the services.yml file. | ||||
FunctionalTestSetupTrait::setupBaseUrl | protected | function | Sets up the base URL based upon the environment variable. | ||||
FunctionalTestSetupTrait::writeSettings | protected | function | Rewrites the settings.php file of the test site. | 1 | |||
NodeCreationTrait::createNode | protected | function | Creates a node based on default settings. | Aliased as: drupalCreateNode | |||
NodeCreationTrait::getNodeByTitle | public | function | Get a node from the database based on its title. | Aliased as: drupalGetNodeByTitle | |||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | ||||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | ||||
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. | ||||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 1 | |||
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. | ||||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||||
TestFileCreationTrait::$generatedTestFiles | protected | property | Whether the files were copied to the test files directory. | ||||
TestFileCreationTrait::compareFiles | protected | function | Compares two files based on size and file name. | ||||
TestFileCreationTrait::generateFile | public static | function | Generates a test file. | ||||
TestFileCreationTrait::getTestFiles | protected | function | Gets a list of files that can be used in tests. | ||||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | ||||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | ||||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. | ||||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 1 | |||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | ||||
TestSetupTrait::$databasePrefix | protected | property | The database prefix of this test run. | ||||
TestSetupTrait::$kernel | protected | property | The DrupalKernel instance used in the test. | ||||
TestSetupTrait::$originalSite | protected | property | The site directory of the original parent site. | ||||
TestSetupTrait::$privateFilesDirectory | protected | property | The private file directory for the test environment. | ||||
TestSetupTrait::$publicFilesDirectory | protected | property | The public file directory for the test environment. | ||||
TestSetupTrait::$root | protected | property | The app root. | ||||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | ||||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 1 | |||
TestSetupTrait::$tempFilesDirectory | protected | property | The temporary file directory for the test environment. | ||||
TestSetupTrait::$testId | protected | property | The test run ID. | ||||
TestSetupTrait::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||||
TestSetupTrait::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||||
TestSetupTrait::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||||
TestSetupTrait::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | 1 | |||
UiHelperTrait::$loggedInUser | protected | property | The current user logged in using the Mink controlled browser. | ||||
UiHelperTrait::$maximumMetaRefreshCount | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | ||||
UiHelperTrait::$metaRefreshCount | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | ||||
UiHelperTrait::buildUrl | protected | function | Builds an absolute URL from a system path or a URL object. | ||||
UiHelperTrait::checkForMetaRefresh | protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | ||||
UiHelperTrait::click | protected | function | Clicks the element with the given CSS selector. | ||||
UiHelperTrait::clickLink | protected | function | Follows a link by complete name. | ||||
UiHelperTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | ||||
UiHelperTrait::cssSelectToXpath | protected | function | Translates a CSS expression to its XPath equivalent. | ||||
UiHelperTrait::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | 2 | |||
UiHelperTrait::drupalLogin | protected | function | Logs in a user using the Mink controlled browser. | ||||
UiHelperTrait::drupalLogout | protected | function | Logs a user out of the Mink controlled browser and confirms. | ||||
UiHelperTrait::drupalPostForm | Deprecated | protected | function | Executes a form submission. | |||
UiHelperTrait::drupalUserIsLoggedIn | protected | function | Returns whether a given user account is logged in. | ||||
UiHelperTrait::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||||
UiHelperTrait::getTextContent | protected | function | Retrieves the plain-text content from the current page. | ||||
UiHelperTrait::getUrl | protected | function | Get the current URL from the browser. | ||||
UiHelperTrait::isTestUsingGuzzleClient | protected | function | Determines if test is using DrupalTestBrowser. | ||||
UiHelperTrait::prepareRequest | protected | function | Prepare for a request to testing site. | 1 | |||
UiHelperTrait::submitForm | protected | function | Fills and submits a form. | ||||
UserCreationTrait::checkPermissions | protected | function | Checks whether a given list of permission names is valid. | ||||
UserCreationTrait::createAdminRole | protected | function | Creates an administrative role. | ||||
UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | Aliased as: drupalCreateRole | |||
UserCreationTrait::createUser | protected | function | Create a user with a given set of permissions. | Aliased as: drupalCreateUser | |||
UserCreationTrait::grantPermissions | protected | function | Grant permissions to a user role. | ||||
UserCreationTrait::setCurrentUser | protected | function | Switch the current logged in user. | ||||
UserCreationTrait::setUpCurrentUser | protected | function | Creates a random user account and sets it as current user. | ||||
WebDriverTestBase::$disableCssAnimations | protected | property | Disables CSS animations in tests for more reliable testing. | ||||
WebDriverTestBase::$failOnJavascriptConsoleErrors | protected | property | Determines if a test should fail on JavaScript console errors. | 3 | |||
WebDriverTestBase::$minkDefaultDriverClass | protected | property | Mink class for the default driver to use. | Overrides BrowserTestBase::$minkDefaultDriverClass | |||
WebDriverTestBase::assertJsCondition | protected | function | Waits for the given time or until the given JS condition becomes TRUE. | ||||
WebDriverTestBase::assertSession | public | function | Returns WebAssert object. | Overrides UiHelperTrait::assertSession | |||
WebDriverTestBase::createScreenshot | protected | function | Creates a screenshot. | ||||
WebDriverTestBase::getDrupalSettings | protected | function | Gets the current Drupal javascript settings and parses into an array. | Overrides BrowserTestBase::getDrupalSettings | |||
WebDriverTestBase::getHtmlOutputHeaders | protected | function | Returns headers in HTML output format. | Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders | |||
WebDriverTestBase::getMinkDriverArgs | protected | function | Gets the Mink driver args from an environment variable. | Overrides BrowserTestBase::getMinkDriverArgs | |||
WebDriverTestBase::initFrontPage | protected | function | Visits the front page when initializing Mink. | Overrides BrowserTestBase::initFrontPage | |||
WebDriverTestBase::initMink | protected | function | Initializes Mink sessions. | Overrides BrowserTestBase::initMink | |||
WebDriverTestBase::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | Overrides FunctionalTestSetupTrait::installModulesFromClassProperty | |||
WebDriverTestBase::tearDown | protected | function | Overrides BrowserTestBase::tearDown | 1 | |||
XdebugRequestTrait::extractCookiesFromRequest | protected | function | Adds xdebug cookies, from request setup. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.