class FieldLayoutTest

Same name in this branch
  1. 8.9.x core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php \Drupal\Tests\field_layout\Functional\FieldLayoutTest
Same name in other branches
  1. 9 core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php \Drupal\Tests\field_layout\FunctionalJavascript\FieldLayoutTest
  2. 9 core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php \Drupal\Tests\field_layout\Functional\FieldLayoutTest
  3. 10 core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php \Drupal\Tests\field_layout\FunctionalJavascript\FieldLayoutTest
  4. 10 core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php \Drupal\Tests\field_layout\Functional\FieldLayoutTest
  5. 11.x core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php \Drupal\Tests\field_layout\FunctionalJavascript\FieldLayoutTest
  6. 11.x core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php \Drupal\Tests\field_layout\Functional\FieldLayoutTest

Tests using field layout for entity displays.

@group field_layout

Hierarchy

Expanded class hierarchy of FieldLayoutTest

File

core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php, line 13

Namespace

Drupal\Tests\field_layout\FunctionalJavascript
View source
class FieldLayoutTest extends WebDriverTestBase {
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'field_layout',
        'field_ui',
        'field_layout_test',
        'layout_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'classy';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $entity = EntityTest::create([
            'name' => 'The name for this entity',
            'field_test_text' => [
                [
                    'value' => 'The field test text value',
                ],
            ],
        ]);
        $entity->save();
        $this->drupalLogin($this->drupalCreateUser([
            'access administration pages',
            'view test entity',
            'administer entity_test content',
            'administer entity_test fields',
            'administer entity_test display',
            'administer entity_test form display',
            'view the administration theme',
        ]));
    }
    
    /**
     * Tests that layouts are unique per view mode.
     */
    public function testEntityViewModes() {
        // By default, the field is not visible.
        $this->drupalGet('entity_test/1/test');
        $this->assertSession()
            ->elementNotExists('css', '.layout__region--content .field--name-field-test-text');
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->elementNotExists('css', '.layout__region--content .field--name-field-test-text');
        // Change the layout for the "test" view mode. See
        // core.entity_view_mode.entity_test.test.yml.
        $this->drupalGet('entity_test/structure/entity_test/display');
        $this->click('#edit-modes');
        $this->getSession()
            ->getPage()
            ->checkField('display_modes_custom[test]');
        $this->submitForm([], 'Save');
        $this->clickLink('configure them');
        $this->getSession()
            ->getPage()
            ->pressButton('Show row weights');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('fields[field_test_text][region]', 'content');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->submitForm([], 'Save');
        // Each view mode has a different layout.
        $this->drupalGet('entity_test/1/test');
        $this->assertSession()
            ->elementExists('css', '.layout__region--content .field--name-field-test-text');
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->elementNotExists('css', '.layout__region--content .field--name-field-test-text');
    }
    
    /**
     * Tests the use of field layout for entity form displays.
     */
    public function testEntityForm() {
        // By default, the one-column layout is used.
        $this->drupalGet('entity_test/manage/1/edit');
        $this->assertFieldInRegion('field_test_text[0][value]', 'content');
        // The one-column layout is in use.
        $this->drupalGet('entity_test/structure/entity_test/form-display');
        $this->assertEquals([
            'Content',
            'Disabled',
        ], $this->getRegionTitles());
        // Switch the layout to two columns.
        $this->click('#edit-field-layouts');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('field_layout', 'layout_twocol');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->submitForm([], 'Save');
        // The field is moved to the default region for the new layout.
        $this->assertSession()
            ->pageTextContains('Your settings have been saved.');
        $this->assertEquals([
            'Top',
            'First',
            'Second',
            'Bottom',
            'Disabled',
        ], $this->getRegionTitles());
        $this->drupalGet('entity_test/manage/1/edit');
        // No fields are visible, and the regions don't display when empty.
        $this->assertFieldInRegion('field_test_text[0][value]', 'first');
        $this->assertSession()
            ->elementExists('css', '.layout__region--first .field--name-field-test-text');
        // After a refresh the new regions are still there.
        $this->drupalGet('entity_test/structure/entity_test/form-display');
        $this->assertEquals([
            'Top',
            'First',
            'Second',
            'Bottom',
            'Disabled',
        ], $this->getRegionTitles());
        $this->assertSession()
            ->waitForElement('css', '.tabledrag-handle');
        $id = $this->getSession()
            ->getPage()
            ->find('css', '[name="form_build_id"]')
            ->getValue();
        // Drag the field to the second region.
        $field_test_text_row = $this->getSession()
            ->getPage()
            ->find('css', '#field-test-text');
        $second_region_row = $this->getSession()
            ->getPage()
            ->find('css', '.region-second-message');
        $field_test_text_row->find('css', '.handle')
            ->dragTo($second_region_row);
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSession()
            ->waitForElement('css', "[name='form_build_id']:not([value='{$id}'])");
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('Your settings have been saved.');
        // The new layout is used.
        $this->drupalGet('entity_test/manage/1/edit');
        $this->assertSession()
            ->elementExists('css', '.layout__region--second .field--name-field-test-text');
        $this->assertFieldInRegion('field_test_text[0][value]', 'second');
        // Move the field to the second region without tabledrag.
        $this->drupalGet('entity_test/structure/entity_test/form-display');
        $this->getSession()
            ->getPage()
            ->pressButton('Show row weights');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('fields[field_test_text][region]', 'second');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('Your settings have been saved.');
        // The updated region is used.
        $this->drupalGet('entity_test/manage/1/edit');
        $this->assertFieldInRegion('field_test_text[0][value]', 'second');
        // The layout is still in use without Field UI.
        $this->container
            ->get('module_installer')
            ->uninstall([
            'field_ui',
        ]);
        $this->drupalGet('entity_test/manage/1/edit');
        $this->assertFieldInRegion('field_test_text[0][value]', 'second');
    }
    
    /**
     * Tests the use of field layout for entity view displays.
     */
    public function testEntityView() {
        // The one-column layout is in use.
        $this->drupalGet('entity_test/structure/entity_test/display');
        $this->assertEquals([
            'Content',
            'Disabled',
        ], $this->getRegionTitles());
        // Switch the layout to two columns.
        $this->click('#edit-field-layouts');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('field_layout', 'layout_twocol');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('Your settings have been saved.');
        $this->assertEquals([
            'Top',
            'First',
            'Second',
            'Bottom',
            'Disabled',
        ], $this->getRegionTitles());
        $this->drupalGet('entity_test/1');
        // No fields are visible, and the regions don't display when empty.
        $this->assertSession()
            ->elementNotExists('css', '.layout--twocol');
        $this->assertSession()
            ->elementNotExists('css', '.layout__region');
        $this->assertSession()
            ->elementNotExists('css', '.field--name-field-test-text');
        // After a refresh the new regions are still there.
        $this->drupalGet('entity_test/structure/entity_test/display');
        $this->assertEquals([
            'Top',
            'First',
            'Second',
            'Bottom',
            'Disabled',
        ], $this->getRegionTitles());
        $this->assertSession()
            ->waitForElement('css', '.tabledrag-handle');
        $id = $this->getSession()
            ->getPage()
            ->find('css', '[name="form_build_id"]')
            ->getValue();
        // Drag the field to the first region.
        $this->assertTrue($this->assertSession()
            ->optionExists('fields[field_test_text][region]', 'hidden')
            ->isSelected());
        $field_test_text_row = $this->getSession()
            ->getPage()
            ->find('css', '#field-test-text');
        $first_region_row = $this->getSession()
            ->getPage()
            ->find('css', '.region-first-message');
        $field_test_text_row->find('css', '.handle')
            ->dragTo($first_region_row);
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertFalse($this->assertSession()
            ->optionExists('fields[field_test_text][region]', 'hidden')
            ->isSelected());
        $this->assertSession()
            ->waitForElement('css', "[name='form_build_id']:not([value='{$id}'])");
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('Your settings have been saved.');
        // The new layout is used.
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->elementExists('css', '.layout--twocol');
        $this->assertSession()
            ->elementExists('css', '.layout__region--first .field--name-field-test-text');
        // Move the field to the second region without tabledrag.
        $this->drupalGet('entity_test/structure/entity_test/display');
        $this->getSession()
            ->getPage()
            ->pressButton('Show row weights');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('fields[field_test_text][region]', 'second');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('Your settings have been saved.');
        // The updated region is used.
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->elementExists('css', '.layout__region--second .field--name-field-test-text');
        // The layout is still in use without Field UI.
        $this->container
            ->get('module_installer')
            ->uninstall([
            'field_ui',
        ]);
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->elementExists('css', '.layout--twocol');
        $this->assertSession()
            ->elementExists('css', '.layout__region--second .field--name-field-test-text');
    }
    
    /**
     * Tests layout plugins with forms.
     */
    public function testLayoutForms() {
        $this->drupalGet('entity_test/structure/entity_test/display');
        // Switch to a field layout with settings.
        $this->click('#edit-field-layouts');
        // Test switching between layouts with and without forms.
        $this->getSession()
            ->getPage()
            ->selectFieldOption('field_layout', 'layout_test_plugin');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSession()
            ->fieldExists('settings_wrapper[layout_settings][setting_1]');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('field_layout', 'layout_test_2col');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSession()
            ->fieldNotExists('settings_wrapper[layout_settings][setting_1]');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('field_layout', 'layout_test_plugin');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSession()
            ->fieldExists('settings_wrapper[layout_settings][setting_1]');
        // Move the test field to the content region.
        $this->getSession()
            ->getPage()
            ->pressButton('Show row weights');
        $this->getSession()
            ->getPage()
            ->selectFieldOption('fields[field_test_text][region]', 'content');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->submitForm([], 'Save');
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->pageTextContains('Blah: Default');
        // Update the field layout settings.
        $this->drupalGet('entity_test/structure/entity_test/display');
        $this->click('#edit-field-layouts');
        $this->getSession()
            ->getPage()
            ->fillField('settings_wrapper[layout_settings][setting_1]', 'Test text');
        $this->submitForm([], 'Save');
        $this->drupalGet('entity_test/1');
        $this->assertSession()
            ->pageTextContains('Blah: Test text');
    }
    
    /**
     * Tests changing the formatter and region at the same time.
     */
    public function testChangingFormatterAndRegion() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        // Add the test field to the content region.
        $this->drupalGet('entity_test/structure/entity_test/display');
        $page->find('css', '#field-test-text .handle')
            ->dragTo($page->find('css', '.region-content-message'));
        $assert_session->assertWaitOnAjaxRequest();
        $page->pressButton('Save');
        $assert_session->fieldValueEquals('fields[field_test_text][region]', 'content');
        $assert_session->fieldValueEquals('fields[field_test_text][type]', 'text_default');
        // Switch the layout to two columns.
        $this->click('#edit-field-layouts');
        $page->selectFieldOption('field_layout', 'layout_twocol');
        $assert_session->assertWaitOnAjaxRequest();
        $page->pressButton('Save');
        $assert_session->fieldValueEquals('fields[field_test_text][region]', 'first');
        // Change the formatter and move to another region.
        $page->selectFieldOption('fields[field_test_text][type]', 'text_trimmed');
        $assert_session->assertWaitOnAjaxRequest();
        $page->find('css', '#field-test-text .handle')
            ->dragTo($page->find('css', '.region-second-message'));
        $assert_session->assertWaitOnAjaxRequest();
        $page->pressButton('Save');
        // Assert that both the formatter and region change are persisted.
        $assert_session->fieldValueEquals('fields[field_test_text][region]', 'second');
        $assert_session->fieldValueEquals('fields[field_test_text][type]', 'text_trimmed');
    }
    
    /**
     * Gets the region titles on the page.
     *
     * @return string[]
     *   An array of region titles.
     */
    protected function getRegionTitles() {
        $region_titles = [];
        $region_title_elements = $this->getSession()
            ->getPage()
            ->findAll('css', '.region-title td');
        
        /** @var \Behat\Mink\Element\NodeElement[] $region_title_elements */
        foreach ($region_title_elements as $region_title_element) {
            $region_titles[] = $region_title_element->getText();
        }
        return $region_titles;
    }
    
    /**
     * Asserts that a field exists in a given region.
     *
     * @param string $field_selector
     *   The field selector, one of field id|name|label|value.
     * @param string $region_name
     *   The machine name of the region.
     */
    protected function assertFieldInRegion($field_selector, $region_name) {
        $region_element = $this->getSession()
            ->getPage()
            ->find('css', ".layout__region--{$region_name}");
        $this->assertNotNull($region_element);
        $this->assertSession()
            ->fieldExists($field_selector, $region_element);
    }

}

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'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::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
FieldLayoutTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FieldLayoutTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
FieldLayoutTest::assertFieldInRegion protected function Asserts that a field exists in a given region.
FieldLayoutTest::getRegionTitles protected function Gets the region titles on the page.
FieldLayoutTest::setUp protected function Overrides BrowserTestBase::setUp
FieldLayoutTest::testChangingFormatterAndRegion public function Tests changing the formatter and region at the same time.
FieldLayoutTest::testEntityForm public function Tests the use of field layout for entity form displays.
FieldLayoutTest::testEntityView public function Tests the use of field layout for entity view displays.
FieldLayoutTest::testEntityViewModes public function Tests that layouts are unique per view mode.
FieldLayoutTest::testLayoutForms public function Tests layout plugins with forms.
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.
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::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.