class LayoutBuilderQuickEditTest

Same name in this branch
  1. 8.9.x core/modules/layout_builder/tests/src/Functional/LayoutBuilderQuickEditTest.php \Drupal\Tests\layout_builder\Functional\LayoutBuilderQuickEditTest
Same name in other branches
  1. 9 core/modules/quickedit/tests/src/FunctionalJavascript/LayoutBuilderQuickEditTest.php \Drupal\Tests\quickedit\FunctionalJavascript\LayoutBuilderQuickEditTest
  2. 9 core/modules/quickedit/tests/src/Functional/LayoutBuilderQuickEditTest.php \Drupal\Tests\quickedit\Functional\LayoutBuilderQuickEditTest

Tests that Layout Builder functions with Quick Edit.

@covers layout_builder_entity_view_alter() @covers layout_builder_quickedit_render_field()

@group layout_builder

Hierarchy

Expanded class hierarchy of LayoutBuilderQuickEditTest

File

core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderQuickEditTest.php, line 18

Namespace

Drupal\Tests\layout_builder\FunctionalJavascript
View source
class LayoutBuilderQuickEditTest extends QuickEditJavascriptTestBase {
    use EntityReferenceTestTrait;
    use ContextualLinkClickTrait;
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'node',
        'layout_builder',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'classy';
    
    /**
     * The article node under test.
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $article;
    
    /**
     * A user with permissions to edit Articles and use Quick Edit.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $contentAuthorUser;
    
    /**
     * Whether the test is currently using Layout Builder on the entity.
     *
     * Allows performing assertions with and without Layout Builder.
     *
     * @var bool
     *
     * @see ::assertEntityInstanceFieldStates()
     * @see ::assertEntityInstanceFieldMarkup()
     */
    protected $usingLayoutBuilder = FALSE;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $this->drupalPlaceBlock('page_title_block');
        // Create the Article node type.
        $this->drupalCreateContentType([
            'type' => 'article',
            'name' => 'Article',
        ]);
        $this->article = $this->drupalCreateNode([
            'type' => 'article',
            'title' => t('My Test Node'),
            'body' => [
                'value' => 'Hello Layout Builder!',
                'format' => 'plain_text',
            ],
        ]);
        // Log in as a content author who can use Quick Edit and edit Articles.
        $this->contentAuthorUser = $this->drupalCreateUser([
            'access contextual links',
            'access in-place editing',
            'access content',
            'edit any article content',
        ]);
        $this->drupalLogin($this->contentAuthorUser);
    }
    
    /**
     * Tests that Quick Edit still works even when there are duplicate fields.
     *
     * @see https://www.drupal.org/project/drupal/issues/3041850
     */
    public function testQuickEditIgnoresDuplicateFields() {
        // Place the body field a second time using Layout Builder.
        $this->enableLayouts('admin/structure/types/manage/article/display/default');
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        $this->loginLayoutAdmin();
        $this->drupalGet('admin/structure/types/manage/article/display/default/layout');
        $page->clickLink('Add block');
        $this->assertNotEmpty($assert_session->waitForElementVisible('css', '#drupal-off-canvas'));
        $assert_session->assertWaitOnAjaxRequest();
        $page->clickLink('Body');
        $assert_session->assertWaitOnAjaxRequest();
        $page->pressButton('Add block');
        $assert_session->assertWaitOnAjaxRequest();
        $page->pressButton('Save layout');
        $this->assertNotEmpty($assert_session->waitForElement('css', '.messages--status'));
        $assert_session->pageTextContains('The layout has been saved.');
        $this->drupalLogin($this->contentAuthorUser);
        $this->usingLayoutBuilder = TRUE;
        $this->assertQuickEditInit([
            'title',
        ]);
        $this->drupalLogin($this->drupalCreateUser([
            'access contextual links',
            'access in-place editing',
            'access content',
            'edit any article content',
            'administer nodes',
        ]));
        $this->assertQuickEditInit([
            'title',
            'uid',
            'created',
        ]);
    }
    
    /**
     * Tests Quick Edit boots correctly with Layout Builder defaults & overrides.
     *
     * @param bool $use_revisions
     *   If revisions are used.
     *
     * @dataProvider providerEnableDisableLayoutBuilder
     */
    public function testEnableDisableLayoutBuilder($use_revisions, $admin_permission = FALSE) {
        if (!$use_revisions) {
            $content_type = NodeType::load('article');
            $content_type->setNewRevision(FALSE);
            $content_type->save();
        }
        $fields = [
            'title',
            'body',
        ];
        if ($admin_permission) {
            $fields = array_merge($fields, [
                'uid',
                'created',
            ]);
            $this->drupalLogin($this->drupalCreateUser([
                'access contextual links',
                'access in-place editing',
                'access content',
                'edit any article content',
                'administer nodes',
            ]));
        }
        // Test article with Layout Builder disabled.
        $this->assertQuickEditInit($fields);
        // Test article with Layout Builder enabled.
        $this->enableLayouts('admin/structure/types/manage/article/display/default');
        $this->usingLayoutBuilder = TRUE;
        $this->assertQuickEditInit($fields);
        // Test article with Layout Builder override.
        $this->createLayoutOverride();
        $this->assertQuickEditInit($fields);
        // If we're using revisions, it's not possible to disable Layout Builder
        // without deleting the node (unless the revisions containing the override
        // would be deleted).
        if (!$use_revisions) {
            // Test article with Layout Builder when reverted back to defaults.
            $this->revertLayoutToDefaults();
            $this->assertQuickEditInit($fields);
            // Test with Layout Builder disabled after being enabled.
            $this->usingLayoutBuilder = FALSE;
            $this->disableLayoutBuilder('admin/structure/types/manage/article/display/default');
            $this->assertQuickEditInit($fields);
        }
    }
    
    /**
     * DataProvider for testEnableDisableLayoutBuilder().
     */
    public function providerEnableDisableLayoutBuilder() {
        return [
            'use revisions, not admin' => [
                TRUE,
            ],
            'do not use revisions, not admin' => [
                FALSE,
            ],
            'use revisions, admin' => [
                TRUE,
                TRUE,
            ],
            'do not use revisions, admin' => [
                FALSE,
                TRUE,
            ],
        ];
    }
    
    /**
     * Enables layouts at an admin path.
     *
     * @param string $path
     *   The manage display path.
     */
    protected function enableLayouts($path) {
        // Save the current user to re-login after Layout Builder changes.
        $user = $this->loggedInUser;
        $this->loginLayoutAdmin();
        $page = $this->getSession()
            ->getPage();
        $this->drupalGet($path);
        $page->checkField('layout[enabled]');
        $page->checkField('layout[allow_custom]');
        $page->pressButton('Save');
        $this->drupalLogin($user);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function assertEntityInstanceFieldStates($entity_type_id, $entity_id, $entity_instance_id, array $expected_field_states) {
        parent::assertEntityInstanceFieldStates($entity_type_id, $entity_id, $entity_instance_id, $this->replaceLayoutBuilderFieldIdKeys($expected_field_states));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function assertEntityInstanceFieldMarkup($entity_type_id, $entity_id, $entity_instance_id, array $expected_field_attributes) {
        parent::assertEntityInstanceFieldMarkup($entity_type_id, $entity_id, $entity_instance_id, $this->replaceLayoutBuilderFieldIdKeys($expected_field_attributes));
    }
    
    /**
     * Replaces the array keys with Layout Builder field IDs when needed.
     *
     * @param array $array
     *   The array with field IDs as keys.
     *
     * @return array
     *   The array with the keys replaced.
     */
    protected function replaceLayoutBuilderFieldIdKeys(array $array) {
        if (!$this->usingLayoutBuilder) {
            return $array;
        }
        $replacement = [];
        foreach ($array as $field_key => $value) {
            $new_field_key = $this->getQuickEditFieldId($field_key);
            $replacement[$new_field_key] = $value;
        }
        return $replacement;
    }
    
    /**
     * Login the Layout admin user for the test.
     */
    protected function loginLayoutAdmin() {
        // Enable for the Layout Builder.
        $this->drupalLogin($this->drupalCreateUser([
            'configure any layout',
            'access content',
            'administer node display',
            'administer node fields',
            'administer blocks',
        ]));
    }
    
    /**
     * Creates a layout override.
     */
    protected function createLayoutOverride() {
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        // Save the current user to re-login after Layout Builder changes.
        $user = $this->loggedInUser;
        $this->loginLayoutAdmin();
        $this->drupalGet('node/' . $this->article
            ->id() . '/layout');
        $page->pressButton('Save layout');
        $this->assertNotEmpty($assert_session->waitForElement('css', '.messages--status'));
        $assert_session->pageTextContains('The layout override has been saved.');
        $this->drupalLogin($user);
    }
    
    /**
     * Reverts a layout override.
     */
    protected function revertLayoutToDefaults() {
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        // Save the current user to re-login after Layout Builder changes.
        $user = $this->loggedInUser;
        $this->loginLayoutAdmin();
        $this->drupalGet('node/' . $this->article
            ->id() . '/layout');
        $assert_session->buttonExists('Revert to defaults');
        $page->pressButton('Revert to defaults');
        $page->pressButton('Revert');
        $assert_session->pageTextContains('The layout has been reverted back to defaults.');
        $this->drupalLogin($user);
    }
    
    /**
     * Disables Layout Builder.
     *
     * @param string $path
     *   The path to the manage display page.
     */
    protected function disableLayoutBuilder($path) {
        $page = $this->getSession()
            ->getPage();
        // Save the current user to re-login after Layout Builder changes.
        $user = $this->loggedInUser;
        $this->loginLayoutAdmin();
        $this->drupalGet($path);
        $page->uncheckField('layout[allow_custom]');
        $page->uncheckField('layout[enabled]');
        $page->pressButton('Save');
        $page->pressButton('Confirm');
        $this->drupalLogin($user);
    }
    
    /**
     * Asserts that Quick Edit is initialized on the node view correctly.
     *
     * @todo Replace calls to this method with calls to ::doTestArticle() in
     *    https://www.drupal.org/node/3037436.
     *
     * @param string[] $fields
     *   The fields test.
     */
    private function assertQuickEditInit(array $fields) {
        $this->assertNotEmpty($fields);
        $node = $this->article;
        $this->drupalGet('node/' . $node->id());
        // Initial state.
        $this->awaitQuickEditForEntity('node', 1);
        $this->assertEntityInstanceStates([
            'node/1[0]' => 'closed',
        ]);
        $field_states = [];
        foreach ($fields as $field) {
            $field_states["node/1/{$field}/en/full"] = 'inactive';
        }
        $this->assertEntityInstanceFieldStates('node', 1, 0, $field_states);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getQuickEditFieldId($original_field_id) {
        $page = $this->getSession()
            ->getPage();
        $parts = explode('/', $original_field_id);
        // Removes the last part of the field id which will contain the Quick Edit
        // view mode ID. When using the Layout Builder the view_mode will contain a
        // hash of the layout sections and will be different each time the layout
        // changes.
        array_pop($parts);
        $field_key_without_view_mode = implode('/', $parts);
        $element = $page->find('css', "[data-quickedit-field-id^=\"{$field_key_without_view_mode}\"]");
        $this->assertNotEmpty($element, "Found Quick Edit-enabled field whose data-quickedit-field attribute starts with: {$field_key_without_view_mode}");
        try {
            $has_attribute = $element->hasAttribute('data-quickedit-field-id');
        } catch (\Exception $e) {
            $has_attribute = FALSE;
        }
        $this->assertTrue($has_attribute, $field_key_without_view_mode);
        $new_field_id = $element->getAttribute('data-quickedit-field-id');
        return $new_field_id;
    }

}

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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue()
instead.
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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals()
instead.
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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame()
instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals()
instead.
AssertLegacyTrait::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 Deprecated Scheduled for removal in Drupal 10.0.0. Use
self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use
self::assertNotSame() instead.
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'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 Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue()
instead.
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::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::$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::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::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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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.
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
ContextualLinkClickTrait::clickContextualLink protected function Clicks a contextual link. 1
ContextualLinkClickTrait::toggleContextualTriggerVisibility protected function Toggles the visibility of a contextual trigger.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 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::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.
LayoutBuilderQuickEditTest::$article protected property The article node under test.
LayoutBuilderQuickEditTest::$contentAuthorUser protected property A user with permissions to edit Articles and use Quick Edit. Overrides QuickEditJavascriptTestBase::$contentAuthorUser
LayoutBuilderQuickEditTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LayoutBuilderQuickEditTest::$modules public static property Modules to enable. Overrides QuickEditJavascriptTestBase::$modules
LayoutBuilderQuickEditTest::$usingLayoutBuilder protected property Whether the test is currently using Layout Builder on the entity.
LayoutBuilderQuickEditTest::assertEntityInstanceFieldMarkup protected function Asserts all in-place editable fields with markup expectations. Overrides QuickEditJavascriptTestBase::assertEntityInstanceFieldMarkup
LayoutBuilderQuickEditTest::assertEntityInstanceFieldStates protected function Asserts all FieldModels for the given entity instance. Overrides QuickEditJavascriptTestBase::assertEntityInstanceFieldStates
LayoutBuilderQuickEditTest::assertQuickEditInit private function Asserts that Quick Edit is initialized on the node view correctly.
LayoutBuilderQuickEditTest::createLayoutOverride protected function Creates a layout override.
LayoutBuilderQuickEditTest::disableLayoutBuilder protected function Disables Layout Builder.
LayoutBuilderQuickEditTest::enableLayouts protected function Enables layouts at an admin path.
LayoutBuilderQuickEditTest::getQuickEditFieldId protected function
LayoutBuilderQuickEditTest::loginLayoutAdmin protected function Login the Layout admin user for the test.
LayoutBuilderQuickEditTest::providerEnableDisableLayoutBuilder public function DataProvider for testEnableDisableLayoutBuilder().
LayoutBuilderQuickEditTest::replaceLayoutBuilderFieldIdKeys protected function Replaces the array keys with Layout Builder field IDs when needed.
LayoutBuilderQuickEditTest::revertLayoutToDefaults protected function Reverts a layout override.
LayoutBuilderQuickEditTest::setUp protected function Overrides BrowserTestBase::setUp
LayoutBuilderQuickEditTest::testEnableDisableLayoutBuilder public function Tests Quick Edit boots correctly with Layout Builder defaults & overrides.
LayoutBuilderQuickEditTest::testQuickEditIgnoresDuplicateFields public function Tests that Quick Edit still works even when there are duplicate fields.
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.
QuickEditJavascriptTestBase::$expectedFieldStateAttributes protected static property
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 'Save' 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 'form' in-place editor.
QuickEditJavascriptTestBase::typeInPlainTextEditor protected function Simulates typing in a 'plain_text' 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. 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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
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 1
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 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.
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 1
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.