class CKEditorAdminTest

Same name in other branches
  1. 9 core/modules/ckeditor/tests/src/Functional/CKEditorAdminTest.php \Drupal\Tests\ckeditor\Functional\CKEditorAdminTest

Tests administration of CKEditor.

@group ckeditor

Hierarchy

Expanded class hierarchy of CKEditorAdminTest

File

core/modules/ckeditor/tests/src/Functional/CKEditorAdminTest.php, line 16

Namespace

Drupal\Tests\ckeditor\Functional
View source
class CKEditorAdminTest extends BrowserTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'filter',
        'editor',
        'ckeditor',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * A user with the 'administer filters' permission.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    protected function setUp() {
        parent::setUp();
        // Create text format.
        $filtered_html_format = FilterFormat::create([
            'format' => 'filtered_html',
            'name' => 'Filtered HTML',
            'weight' => 0,
            'filters' => [],
        ]);
        $filtered_html_format->save();
        // Create admin user.
        $this->adminUser = $this->drupalCreateUser([
            'administer filters',
        ]);
    }
    
    /**
     * Tests configuring a text editor for an existing text format.
     */
    public function testExistingFormat() {
        $ckeditor = $this->container
            ->get('plugin.manager.editor')
            ->createInstance('ckeditor');
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        // Ensure no Editor config entity exists yet.
        $editor = Editor::load('filtered_html');
        $this->assertNull($editor, 'No Editor config entity exists yet.');
        // Verify the "Text Editor" <select> when a text editor is available.
        $select = $this->xpath('//select[@name="editor[editor]"]');
        $select_is_disabled = $this->xpath('//select[@name="editor[editor]" and @disabled="disabled"]');
        $options = $this->xpath('//select[@name="editor[editor]"]/option');
        $this->assertCount(1, $select, 'The Text Editor select exists.');
        $this->assertCount(0, $select_is_disabled, 'The Text Editor select is not disabled.');
        $this->assertCount(2, $options, 'The Text Editor select has two options.');
        $this->assertSame('None', $options[0]->getText(), 'Option 1 in the Text Editor select is "None".');
        $this->assertSame('CKEditor', $options[1]->getText(), 'Option 2 in the Text Editor select is "CKEditor".');
        $this->assertSame('selected', $options[0]->getAttribute('selected'), 'Option 1 ("None") is selected.');
        // Select the "CKEditor" editor and click the "Save configuration" button.
        $edit = [
            'editor[editor]' => 'ckeditor',
        ];
        $this->drupalPostForm(NULL, $edit, t('Save configuration'));
        $this->assertRaw(t('You must configure the selected text editor.'));
        // Ensure the CKEditor editor returns the expected default settings.
        $expected_default_settings = [
            'toolbar' => [
                'rows' => [
                    // Button groups
[
                        [
                            'name' => 'Formatting',
                            'items' => [
                                'Bold',
                                'Italic',
                            ],
                        ],
                        [
                            'name' => 'Links',
                            'items' => [
                                'DrupalLink',
                                'DrupalUnlink',
                            ],
                        ],
                        [
                            'name' => 'Lists',
                            'items' => [
                                'BulletedList',
                                'NumberedList',
                            ],
                        ],
                        [
                            'name' => 'Media',
                            'items' => [
                                'Blockquote',
                                'DrupalImage',
                            ],
                        ],
                        [
                            'name' => 'Tools',
                            'items' => [
                                'Source',
                            ],
                        ],
                    ],
                ],
            ],
            'plugins' => [
                'language' => [
                    'language_list' => 'un',
                ],
            ],
        ];
        $this->assertIdentical($this->castSafeStrings($ckeditor->getDefaultSettings()), $expected_default_settings);
        // Keep the "CKEditor" editor selected and click the "Configure" button.
        $this->drupalPostForm(NULL, $edit, 'editor_configure');
        $editor = Editor::load('filtered_html');
        $this->assertNull($editor, 'No Editor config entity exists yet.');
        // Ensure that drupalSettings is correct.
        $ckeditor_settings_toolbar = [
            '#theme' => 'ckeditor_settings_toolbar',
            '#editor' => Editor::create([
                'editor' => 'ckeditor',
            ]),
            '#plugins' => $this->container
                ->get('plugin.manager.ckeditor.plugin')
                ->getButtons(),
        ];
        $settings = $this->getDrupalSettings();
        $expected = $settings['ckeditor']['toolbarAdmin'];
        $this->assertEqual($expected, $this->container
            ->get('renderer')
            ->renderPlain($ckeditor_settings_toolbar), 'CKEditor toolbar settings are rendered as part of drupalSettings.');
        // Ensure the toolbar buttons configuration value is initialized to the
        // expected default value.
        $expected_buttons_value = json_encode($expected_default_settings['toolbar']['rows']);
        $this->assertFieldByName('editor[settings][toolbar][button_groups]', $expected_buttons_value);
        // Ensure the styles textarea exists and is initialized empty.
        $styles_textarea = $this->xpath('//textarea[@name="editor[settings][plugins][stylescombo][styles]"]');
        $this->assertFieldByXPath('//textarea[@name="editor[settings][plugins][stylescombo][styles]"]', '', 'The styles textarea exists and is empty.');
        $this->assertCount(1, $styles_textarea, 'The "styles" textarea exists.');
        // Submit the form to save the selection of CKEditor as the chosen editor.
        $this->drupalPostForm(NULL, $edit, t('Save configuration'));
        // Ensure an Editor object exists now, with the proper settings.
        $expected_settings = $expected_default_settings;
        $expected_settings['plugins']['stylescombo']['styles'] = '';
        $editor = Editor::load('filtered_html');
        $this->assertInstanceOf(Editor::class, $editor);
        $this->assertEqual($expected_settings, $editor->getSettings(), 'The Editor config entity has the correct settings.');
        // Configure the Styles plugin, and ensure the updated settings are saved.
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        $edit = [
            'editor[settings][plugins][stylescombo][styles]' => "h1.title|Title\np.callout|Callout\n\n",
        ];
        $this->drupalPostForm(NULL, $edit, t('Save configuration'));
        $expected_settings['plugins']['stylescombo']['styles'] = "h1.title|Title\np.callout|Callout\n\n";
        $editor = Editor::load('filtered_html');
        $this->assertInstanceOf(Editor::class, $editor);
        $this->assertEqual($expected_settings, $editor->getSettings(), 'The Editor config entity has the correct settings.');
        // Change the buttons that appear on the toolbar (in JavaScript, this is
        // done via drag and drop, but here we can only emulate the end result of
        // that interaction). Test multiple toolbar rows and a divider within a row.
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        $expected_settings['toolbar']['rows'][0][] = [
            'name' => 'Action history',
            'items' => [
                'Undo',
                '|',
                'Redo',
                'JustifyCenter',
            ],
        ];
        $edit = [
            'editor[settings][toolbar][button_groups]' => json_encode($expected_settings['toolbar']['rows']),
        ];
        $this->drupalPostForm(NULL, $edit, t('Save configuration'));
        $editor = Editor::load('filtered_html');
        $this->assertInstanceOf(Editor::class, $editor);
        $this->assertEqual($expected_settings, $editor->getSettings(), 'The Editor config entity has the correct settings.');
        // Check that the markup we're setting for the toolbar buttons (actually in
        // JavaScript's drupalSettings, and Unicode-escaped) is correctly rendered.
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        // Create function to encode HTML as we expect it in drupalSettings.
        $json_encode = function ($html) {
            return trim(Json::encode($html), '"');
        };
        // Check the Button separator.
        $this->assertRaw($json_encode('<li data-drupal-ckeditor-button-name="-" class="ckeditor-button-separator ckeditor-multiple-button" data-drupal-ckeditor-type="separator"><a href="#" role="button" aria-label="Button separator" class="ckeditor-separator"></a></li>'));
        // Check the Format dropdown.
        $this->assertRaw($json_encode('<li data-drupal-ckeditor-button-name="Format" class="ckeditor-button"><a href="#" role="button" aria-label="Format"><span class="ckeditor-button-dropdown">Format<span class="ckeditor-button-arrow"></span></span></a></li>'));
        // Check the Styles dropdown.
        $this->assertRaw($json_encode('<li data-drupal-ckeditor-button-name="Styles" class="ckeditor-button"><a href="#" role="button" aria-label="Styles"><span class="ckeditor-button-dropdown">Styles<span class="ckeditor-button-arrow"></span></span></a></li>'));
        // Check strikethrough.
        $this->assertRaw($json_encode('<li data-drupal-ckeditor-button-name="Strike" class="ckeditor-button"><a href="#" class="cke-icon-only cke_ltr" role="button" title="strike" aria-label="strike"><span class="cke_button_icon cke_button__strike_icon">strike</span></a></li>'));
        // Now enable the ckeditor_test module, which provides one configurable
        // CKEditor plugin — this should not affect the Editor config entity.
        \Drupal::service('module_installer')->install([
            'ckeditor_test',
        ]);
        $this->resetAll();
        $this->container
            ->get('plugin.manager.ckeditor.plugin')
            ->clearCachedDefinitions();
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        $ultra_llama_mode_checkbox = $this->xpath('//input[@type="checkbox" and @name="editor[settings][plugins][llama_contextual_and_button][ultra_llama_mode]" and not(@checked)]');
        $this->assertCount(1, $ultra_llama_mode_checkbox, 'The "Ultra llama mode" checkbox exists and is not checked.');
        $editor = Editor::load('filtered_html');
        $this->assertInstanceOf(Editor::class, $editor);
        $this->assertEqual($expected_settings, $editor->getSettings(), 'The Editor config entity has the correct settings.');
        // Finally, check the "Ultra llama mode" checkbox.
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        $edit = [
            'editor[settings][plugins][llama_contextual_and_button][ultra_llama_mode]' => '1',
        ];
        $this->drupalPostForm(NULL, $edit, t('Save configuration'));
        $this->drupalGet('admin/config/content/formats/manage/filtered_html');
        $ultra_llama_mode_checkbox = $this->xpath('//input[@type="checkbox" and @name="editor[settings][plugins][llama_contextual_and_button][ultra_llama_mode]" and @checked="checked"]');
        $this->assertCount(1, $ultra_llama_mode_checkbox, 'The "Ultra llama mode" checkbox exists and is checked.');
        $expected_settings['plugins']['llama_contextual_and_button']['ultra_llama_mode'] = TRUE;
        $editor = Editor::load('filtered_html');
        $this->assertInstanceOf(Editor::class, $editor);
        $this->assertEqual($expected_settings, $editor->getSettings());
        $this->drupalGet('admin/config/content/formats/add');
        // Now attempt to add another filter format with the same editor and same
        // machine name.
        $edit = [
            'format' => 'filtered_html',
            'name' => 'Filtered HTML',
            'editor[editor]' => 'ckeditor',
        ];
        $this->submitForm($edit, 'editor_configure');
        $this->submitForm($edit, 'Save configuration');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertText('The machine-readable name is already in use. It must be unique.');
    }
    
    /**
     * Tests configuring a text editor for a new text format.
     *
     * This test only needs to ensure that the basics of the CKEditor
     * configuration form work; details are tested in testExistingFormat().
     */
    public function testNewFormat() {
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/config/content/formats/add');
        // Verify the "Text Editor" <select> when a text editor is available.
        $select = $this->xpath('//select[@name="editor[editor]"]');
        $select_is_disabled = $this->xpath('//select[@name="editor[editor]" and @disabled="disabled"]');
        $options = $this->xpath('//select[@name="editor[editor]"]/option');
        $this->assertCount(1, $select, 'The Text Editor select exists.');
        $this->assertCount(0, $select_is_disabled, 'The Text Editor select is not disabled.');
        $this->assertCount(2, $options, 'The Text Editor select has two options.');
        $this->assertSame('None', $options[0]->getText(), 'Option 1 in the Text Editor select is "None".');
        $this->assertSame('CKEditor', $options[1]->getText(), 'Option 2 in the Text Editor select is "CKEditor".');
        $this->assertSame('selected', $options[0]->getAttribute('selected'), 'Option 1 ("None") is selected.');
        // Name our fancy new text format, select the "CKEditor" editor and click
        // the "Configure" button.
        $edit = [
            'name' => 'My amazing text format',
            'format' => 'amazing_format',
            'editor[editor]' => 'ckeditor',
        ];
        $this->drupalPostForm(NULL, $edit, 'editor_configure');
        $filter_format = FilterFormat::load('amazing_format');
        $this->assertNull($filter_format, 'No FilterFormat config entity exists yet.');
        $editor = Editor::load('amazing_format');
        $this->assertNull($editor, 'No Editor config entity exists yet.');
        // Ensure the toolbar buttons configuration value is initialized to the
        // default value.
        $ckeditor = $this->container
            ->get('plugin.manager.editor')
            ->createInstance('ckeditor');
        $default_settings = $ckeditor->getDefaultSettings();
        $expected_buttons_value = json_encode($default_settings['toolbar']['rows']);
        $this->assertFieldByName('editor[settings][toolbar][button_groups]', $expected_buttons_value);
        // Regression test for https://www.drupal.org/node/2606460.
        $settings = $this->getDrupalSettings();
        $expected = $settings['ckeditor']['toolbarAdmin'];
        $this->assertStringContainsString('<li data-drupal-ckeditor-button-name="Bold" class="ckeditor-button"><a href="#" class="cke-icon-only cke_ltr" role="button" title="bold" aria-label="bold"><span class="cke_button_icon cke_button__bold_icon">bold</span></a></li>', $expected);
        // Ensure the styles textarea exists and is initialized empty.
        $styles_textarea = $this->xpath('//textarea[@name="editor[settings][plugins][stylescombo][styles]"]');
        $this->assertFieldByXPath('//textarea[@name="editor[settings][plugins][stylescombo][styles]"]', '', 'The styles textarea exists and is empty.');
        $this->assertCount(1, $styles_textarea, 'The "styles" textarea exists.');
        // Submit the form to create both a new text format and an associated text
        // editor.
        $this->drupalPostForm(NULL, $edit, t('Save configuration'));
        // Ensure a FilterFormat object exists now.
        $filter_format = FilterFormat::load('amazing_format');
        $this->assertInstanceOf(FilterFormatInterface::class, $filter_format);
        // Ensure an Editor object exists now, with the proper settings.
        $expected_settings = $default_settings;
        $expected_settings['plugins']['stylescombo']['styles'] = '';
        $editor = Editor::load('amazing_format');
        $this->assertInstanceOf(Editor::class, $editor);
        $this->assertEqual($this->castSafeStrings($expected_settings), $this->castSafeStrings($editor->getSettings()), 'The Editor config entity has the correct settings.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose 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 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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
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. 39
BrowserTestBase::$root protected property The app root.
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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CKEditorAdminTest::$adminUser protected property A user with the &#039;administer filters&#039; permission.
CKEditorAdminTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CKEditorAdminTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
CKEditorAdminTest::setUp protected function Overrides BrowserTestBase::setUp
CKEditorAdminTest::testExistingFormat public function Tests configuring a text editor for an existing text format.
CKEditorAdminTest::testNewFormat public function Tests configuring a text editor for a new text format.
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
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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. 2
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::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
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. 2
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.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
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.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
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::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
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. 2
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::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
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 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::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.
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.