class LayoutBuilderIntegrationTest

@group quickedit @group legacy

Hierarchy

Expanded class hierarchy of LayoutBuilderIntegrationTest

File

core/modules/quickedit/tests/src/FunctionalJavascript/LayoutBuilderIntegrationTest.php, line 18

Namespace

Drupal\Tests\quickedit\FunctionalJavascript
View source
class LayoutBuilderIntegrationTest extends QuickEditJavascriptTestBase {
    use EntityReferenceTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'editor',
        'ckeditor',
        'taxonomy',
        'block',
        'block_content',
        'hold_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * A user with permissions to edit Articles and use Quick Edit.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $contentAuthorUser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create text format, associate CKEditor.
        FilterFormat::create([
            'format' => 'some_format',
            'name' => 'Some format',
            'weight' => 0,
            'filters' => [
                'filter_html' => [
                    'status' => 1,
                    'settings' => [
                        'allowed_html' => '<h2 id> <h3> <h4> <h5> <h6> <p> <br> <strong> <a href hreflang>',
                    ],
                ],
            ],
        ])->save();
        Editor::create([
            'format' => 'some_format',
            'editor' => 'ckeditor',
        ])->save();
        // Create the Article node type.
        $this->drupalCreateContentType([
            'type' => 'article',
            'name' => 'Article',
        ]);
        // Add "tags" vocabulary + field to the Article node type.
        $vocabulary = Vocabulary::create([
            'name' => 'Tags',
            'vid' => 'tags',
        ]);
        $vocabulary->save();
        $field_name = 'field_' . $vocabulary->id();
        $handler_settings = [
            'target_bundles' => [
                $vocabulary->id() => $vocabulary->id(),
            ],
            'auto_create' => TRUE,
        ];
        $this->createEntityReferenceField('node', 'article', $field_name, 'Tags', 'taxonomy_term', 'default', $handler_settings, FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        // Add formatter & widget for "tags" field.
        \Drupal::entityTypeManager()->getStorage('entity_form_display')
            ->load('node.article.default')
            ->setComponent($field_name, [
            'type' => 'entity_reference_autocomplete_tags',
        ])
            ->save();
        \Drupal::entityTypeManager()->getStorage('entity_view_display')
            ->load('node.article.default')
            ->setComponent($field_name, [
            'type' => 'entity_reference_label',
        ])
            ->save();
        $this->drupalPlaceBlock('page_title_block');
        $this->drupalPlaceBlock('system_main_block');
        // Log in as a content author who can use Quick Edit and edit Articles.
        $this->contentAuthorUser = $this->drupalCreateUser([
            'access contextual links',
            'access toolbar',
            'access in-place editing',
            'access content',
            'create article content',
            'edit any article content',
            'use text format some_format',
            'edit terms in tags',
            'administer blocks',
        ]);
        $this->drupalLogin($this->contentAuthorUser);
    }
    
    /**
     * Tests if an article node can be in-place edited with Quick Edit.
     */
    public function testArticleNode() {
        $term = Term::create([
            'name' => 'foo',
            'vid' => 'tags',
        ]);
        $term->save();
        $node = $this->drupalCreateNode([
            'type' => 'article',
            'title' => 'My Test Node',
            'body' => [
                'value' => '<p>Hello world!</p><p>I do not know what to say…</p><p>I wish I were eloquent.</p>',
                'format' => 'some_format',
            ],
            'field_tags' => [
                [
                    'target_id' => $term->id(),
                ],
            ],
        ]);
        // Move "tags" field to the top of all fields, so its Quick Edit Toolbar
        // won't overlap any Quick Edit-able fields, which causes (semi-)random test
        // failures.
        \Drupal::entityTypeManager()->getStorage('entity_view_display')
            ->load('node.article.default')
            ->setComponent('field_tags', [
            'type' => 'entity_reference_label',
            'weight' => 0,
        ])
            ->save();
        $this->drupalGet('node/' . $node->id());
        // Initial state.
        $this->awaitQuickEditForEntity('node', 1);
        $this->assertEntityInstanceStates([
            'node/1[0]' => 'closed',
        ]);
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/title/en/full' => 'inactive',
            'node/1/body/en/full' => 'inactive',
            'node/1/field_tags/en/full' => 'inactive',
        ]);
        // Start in-place editing of the article node.
        $this->startQuickEditViaToolbar('node', 1, 0);
        $this->assertEntityInstanceStates([
            'node/1[0]' => 'opened',
        ]);
        $this->assertQuickEditEntityToolbar((string) $node->label(), NULL);
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/title/en/full' => 'candidate',
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'candidate',
        ]);
        $assert_session = $this->assertSession();
        // Click the title field.
        $this->click('[data-quickedit-field-id="node/1/title/en/full"].quickedit-candidate');
        $assert_session->waitForElement('css', '.quickedit-toolbar-field div[id*="title"]');
        $this->assertQuickEditEntityToolbar((string) $node->label(), 'Title');
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/title/en/full' => 'active',
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'candidate',
        ]);
        $this->assertEntityInstanceFieldMarkup([
            'node/1/title/en/full' => '[contenteditable="true"]',
        ]);
        // Append something to the title.
        $this->typeInPlainTextEditor('[data-quickedit-field-id="node/1/title/en/full"].quickedit-candidate', ' Llamas are awesome!');
        $this->awaitEntityInstanceFieldState('node', 1, 0, 'title', 'en', 'changed');
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/title/en/full' => 'changed',
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'candidate',
        ]);
        // Click the body field.
        hold_test_response(TRUE);
        $this->click('[data-quickedit-entity-id="node/1"] .field--name-body');
        $assert_session->waitForElement('css', '.quickedit-toolbar-field div[id*="body"]');
        $this->assertQuickEditEntityToolbar((string) $node->label(), 'Body');
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/title/en/full' => 'saving',
            'node/1/body/en/full' => 'active',
            'node/1/field_tags/en/full' => 'candidate',
        ]);
        hold_test_response(FALSE);
        $this->assertEntityInstanceFieldMarkup([
            'node/1/body/en/full' => '.cke_editable_inline',
            'node/1/field_tags/en/full' => ':not(.quickedit-editor-is-popup)',
        ]);
        $this->assertSession()
            ->elementExists('css', '#quickedit-entity-toolbar .quickedit-toolgroup.wysiwyg-main > .cke_chrome .cke_top[role="presentation"] .cke_toolbar[role="toolbar"] .cke_toolgroup[role="presentation"] > .cke_button[title~="Bold"][role="button"]');
        // Wait for the validating & saving of the title to complete.
        $this->awaitEntityInstanceFieldState('node', 1, 0, 'title', 'en', 'candidate');
        // Click the tags field.
        hold_test_response(TRUE);
        $this->click('[data-quickedit-field-id="node/1/field_tags/en/full"]');
        $assert_session->waitForElement('css', '.quickedit-toolbar-field div[id*="tags"]');
        $this->assertQuickEditEntityToolbar((string) $node->label(), 'Tags');
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'activating',
            'node/1/title/en/full' => 'candidate',
        ]);
        $this->assertEntityInstanceFieldMarkup([
            'node/1/title/en/full' => '.quickedit-changed',
            'node/1/field_tags/en/full' => '.quickedit-editor-is-popup',
        ]);
        // Assert the "Loading…" popup appears.
        $this->assertSession()
            ->elementExists('css', '.quickedit-form-container > .quickedit-form[role="dialog"] > .placeholder');
        hold_test_response(FALSE);
        // Wait for the form to load.
        $this->assertJsCondition('document.querySelector(\'.quickedit-form-container > .quickedit-form[role="dialog"] > .placeholder\') === null');
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'active',
            'node/1/title/en/full' => 'candidate',
        ]);
        // Enter an additional tag.
        $this->typeInFormEditorTextInputField('field_tags[target_id]', 'foo, bar');
        $this->awaitEntityInstanceFieldState('node', 1, 0, 'field_tags', 'en', 'changed');
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'changed',
            'node/1/title/en/full' => 'candidate',
        ]);
        // Click 'Save'.
        hold_test_response(TRUE);
        $this->saveQuickEdit();
        $this->assertEntityInstanceStates([
            'node/1[0]' => 'committing',
        ]);
        $this->assertEntityInstanceFieldStates('node', 1, 0, [
            'node/1/body/en/full' => 'candidate',
            'node/1/field_tags/en/full' => 'saving',
            'node/1/title/en/full' => 'candidate',
        ]);
        $this->assertEntityInstanceFieldMarkup([
            'node/1/title/en/full' => '.quickedit-changed',
            'node/1/field_tags/en/full' => '.quickedit-changed',
        ]);
        hold_test_response(FALSE);
        // Wait for the saving of the tags field to complete.
        $this->assertJsCondition("Drupal.quickedit.collections.entities.get('node/1[0]').get('state') === 'closed'");
        $this->assertEntityInstanceStates([
            'node/1[0]' => 'closed',
        ]);
        // Get the load again and ensure the values are the expected values.
        $this->drupalGet('node/' . $node->id());
        $this->assertSession()
            ->pageTextContains(' Llamas are awesome!');
        $this->assertSession()
            ->linkExists('foo');
        $this->assertSession()
            ->linkExists('bar');
    }
    
    /**
     * Tests if a custom can be in-place edited with Quick Edit.
     */
    public function testCustomBlock() {
        $block_content_type = BlockContentType::create([
            'id' => 'basic',
            'label' => 'basic',
            'revision' => FALSE,
        ]);
        $block_content_type->save();
        block_content_add_body_field($block_content_type->id());
        $block_content = BlockContent::create([
            'info' => 'Llama',
            'type' => 'basic',
            'body' => [
                'value' => 'The name "llama" was adopted by European settlers from native Peruvians.',
                'format' => 'some_format',
            ],
        ]);
        $block_content->save();
        $this->drupalPlaceBlock('block_content:' . $block_content->uuid(), [
            'label' => 'My custom block!',
        ]);
        $this->drupalGet('');
        // Initial state.
        $this->awaitQuickEditForEntity('block_content', 1);
        $this->assertEntityInstanceStates([
            'block_content/1[0]' => 'closed',
        ]);
        // Start in-place editing of the article node.
        $this->startQuickEditViaToolbar('block_content', 1, 0);
        $this->assertEntityInstanceStates([
            'block_content/1[0]' => 'opened',
        ]);
        // The label 'body' will only be shown when the pointer hovers over the
        // body. This can't be guaranteed by "just" opening the block in QuickEdit.
        // We explicitly move the pointer first over the page title and afterwards
        // over the block body to be sure.
        $this->movePointerTo('.page-title');
        $this->movePointerTo('[data-quickedit-field-id="block_content/1/body/en/full"]');
        $this->assertQuickEditEntityToolbar((string) $block_content->label(), 'Body');
        $this->assertEntityInstanceFieldStates('block_content', 1, 0, [
            'block_content/1/body/en/full' => 'highlighted',
        ]);
        // Click the body field.
        $this->click('[data-quickedit-entity-id="block_content/1"] .field--name-body');
        $assert_session = $this->assertSession();
        $assert_session->waitForElement('css', '.quickedit-toolbar-field div[id*="body"]');
        $this->assertQuickEditEntityToolbar((string) $block_content->label(), 'Body');
        $this->assertEntityInstanceFieldStates('block_content', 1, 0, [
            'block_content/1/body/en/full' => 'active',
        ]);
        $this->assertEntityInstanceFieldMarkup([
            'block_content/1/body/en/full' => '.cke_editable_inline',
        ]);
        $this->assertSession()
            ->elementExists('css', '#quickedit-entity-toolbar .quickedit-toolgroup.wysiwyg-main > .cke_chrome .cke_top[role="presentation"] .cke_toolbar[role="toolbar"] .cke_toolgroup[role="presentation"] > .cke_button[title~="Bold"][role="button"]');
    }
    
    /**
     * Moves mouse pointer to location of $selector.
     *
     * @param string $selector
     *   CSS selector.
     */
    protected function movePointerTo($selector) {
        $driver_session = $this->getSession()
            ->getDriver()
            ->getWebDriverSession();
        $element = $driver_session->element('css selector', $selector);
        $driver_session->moveto([
            'element' => $element->getID(),
        ]);
    }

}

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&#039;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.
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
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
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. 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
LayoutBuilderIntegrationTest::$contentAuthorUser protected property A user with permissions to edit Articles and use Quick Edit. Overrides QuickEditJavascriptTestBase::$contentAuthorUser
LayoutBuilderIntegrationTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LayoutBuilderIntegrationTest::$modules protected static property Modules to enable. Overrides QuickEditJavascriptTestBase::$modules
LayoutBuilderIntegrationTest::movePointerTo protected function Moves mouse pointer to location of $selector.
LayoutBuilderIntegrationTest::setUp protected function Overrides BrowserTestBase::setUp
LayoutBuilderIntegrationTest::testArticleNode public function Tests if an article node can be in-place edited with Quick Edit.
LayoutBuilderIntegrationTest::testCustomBlock public function Tests if a custom can be in-place edited with Quick Edit.
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.
QuickEditJavascriptTestBase::$expectedFieldStateAttributes protected static property
QuickEditJavascriptTestBase::assertEntityInstanceFieldMarkup protected function Asserts all in-place editable fields with markup expectations. 1
QuickEditJavascriptTestBase::assertEntityInstanceFieldStates protected function Asserts all FieldModels for the given entity instance. 1
QuickEditJavascriptTestBase::assertEntityInstanceStates protected function Asserts all EntityModels (entity instances) on the page.
QuickEditJavascriptTestBase::assertQuickEditEntityToolbar protected function Asserts the state of the Quick Edit entity toolbar.
QuickEditJavascriptTestBase::awaitEntityInstanceFieldState protected function Awaits a particular field instance to reach a particular state.
QuickEditJavascriptTestBase::awaitQuickEditForEntity protected function Awaits Quick Edit to be initiated for all instances of the given entity.
QuickEditJavascriptTestBase::saveQuickEdit protected function Clicks the &#039;Save&#039; button in the Quick Edit entity toolbar.
QuickEditJavascriptTestBase::startQuickEditViaToolbar protected function Starts in-place editing of the given entity instance.
QuickEditJavascriptTestBase::typeInFormEditorTextInputField protected function Simulates typing in an input[type=text] inside a &#039;form&#039; in-place editor.
QuickEditJavascriptTestBase::typeInPlainTextEditor protected function Simulates typing in a &#039;plain_text&#039; in-place editor.
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.
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.