class ConfigEntityListTest

Same name in other branches
  1. 9 core/modules/config/tests/src/Functional/ConfigEntityListTest.php \Drupal\Tests\config\Functional\ConfigEntityListTest
  2. 8.9.x core/modules/config/tests/src/Functional/ConfigEntityListTest.php \Drupal\Tests\config\Functional\ConfigEntityListTest
  3. 11.x core/modules/config/tests/src/Functional/ConfigEntityListTest.php \Drupal\Tests\config\Functional\ConfigEntityListTest

Tests the listing of configuration entities.

@group config

Hierarchy

Expanded class hierarchy of ConfigEntityListTest

File

core/modules/config/tests/src/Functional/ConfigEntityListTest.php, line 18

Namespace

Drupal\Tests\config\Functional
View source
class ConfigEntityListTest extends BrowserTestBase {
    use RedirectDestinationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'config_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Delete the override config_test entity since it is not required by this
        // test.
        \Drupal::entityTypeManager()->getStorage('config_test')
            ->load('override')
            ->delete();
        $this->drupalPlaceBlock('local_actions_block');
    }
    
    /**
     * Tests entity list builder methods.
     */
    public function testList() : void {
        $controller = \Drupal::entityTypeManager()->getListBuilder('config_test');
        // Test getStorage() method.
        $this->assertInstanceOf(EntityStorageInterface::class, $controller->getStorage());
        // Get a list of ConfigTest entities and confirm that it contains the
        // ConfigTest entity provided by the config_test module.
        // @see config_test.dynamic.dotted.default.yml
        $list = $controller->load();
        $this->assertCount(1, $list, '1 ConfigTest entity found.');
        $entity = $list['dotted.default'];
        $this->assertInstanceOf(ConfigTest::class, $entity);
        // Test getOperations() method.
        $edit_url = $entity->toUrl()
            ->setOption('query', $this->getRedirectDestination()
            ->getAsArray());
        $edit_url->setOption('attributes', [
            'aria-label' => 'Edit ' . $entity->label(),
        ]);
        $delete_url = $entity->toUrl('delete-form')
            ->setOption('query', $this->getRedirectDestination()
            ->getAsArray());
        $delete_url->setOption('attributes', [
            'aria-label' => 'Delete ' . $entity->label(),
        ]);
        $expected_operations = [
            'edit' => [
                'title' => 'Edit',
                'weight' => 10,
                'url' => $edit_url,
            ],
            'disable' => [
                'title' => 'Disable',
                'weight' => 40,
                'url' => $entity->toUrl('disable')
                    ->setOption('query', $this->getRedirectDestination()
                    ->getAsArray()),
            ],
            'delete' => [
                'title' => 'Delete',
                'weight' => 100,
                'attributes' => [
                    'class' => [
                        'use-ajax',
                    ],
                    'data-dialog-type' => 'modal',
                    'data-dialog-options' => Json::encode([
                        'width' => 880,
                    ]),
                ],
                'url' => $delete_url,
            ],
        ];
        $actual_operations = $controller->getOperations($entity);
        // Sort the operations to normalize link order.
        uasort($actual_operations, [
            'Drupal\\Component\\Utility\\SortArray',
            'sortByWeightElement',
        ]);
        $this->assertEquals($expected_operations, $actual_operations, 'The operations are identical.');
        // Test buildHeader() method.
        $expected_items = [
            'label' => 'Label',
            'id' => 'Machine name',
            'operations' => 'Operations',
        ];
        $actual_items = $controller->buildHeader();
        $this->assertEquals($expected_items, $actual_items, 'Return value from buildHeader matches expected.');
        // Test buildRow() method.
        $build_operations = $controller->buildOperations($entity);
        $expected_items = [
            'label' => 'Default',
            'id' => 'dotted.default',
            'operations' => [
                'data' => $build_operations,
            ],
        ];
        $actual_items = $controller->buildRow($entity);
        $this->assertEquals($expected_items, $actual_items, 'Return value from buildRow matches expected.');
        // Test sorting.
        $storage = $controller->getStorage();
        $entity = $storage->create([
            'id' => 'alpha',
            'label' => 'Alpha',
            'weight' => 1,
        ]);
        $entity->save();
        $entity = $storage->create([
            'id' => 'omega',
            'label' => 'Omega',
            'weight' => 1,
        ]);
        $entity->save();
        $entity = $storage->create([
            'id' => 'beta',
            'label' => 'Beta',
            'weight' => 0,
        ]);
        $entity->save();
        $list = $controller->load();
        $this->assertSame([
            'beta',
            'dotted.default',
            'alpha',
            'omega',
        ], array_keys($list));
        // Test that config entities that do not support status, do not have
        // enable/disable operations.
        $controller = $this->container
            ->get('entity_type.manager')
            ->getListBuilder('config_test_no_status');
        $list = $controller->load();
        $entity = $list['default'];
        // Test getOperations() method.
        $edit_url = $entity->toUrl()
            ->setOption('query', $this->getRedirectDestination()
            ->getAsArray());
        $edit_url->setOption('attributes', [
            'aria-label' => 'Edit ' . $entity->label(),
        ]);
        $delete_url = $entity->toUrl('delete-form')
            ->setOption('query', $this->getRedirectDestination()
            ->getAsArray());
        $delete_url->setOption('attributes', [
            'aria-label' => 'Delete ' . $entity->label(),
        ]);
        $expected_operations = [
            'edit' => [
                'title' => 'Edit',
                'weight' => 10,
                'url' => $edit_url,
            ],
            'delete' => [
                'title' => 'Delete',
                'weight' => 100,
                'attributes' => [
                    'class' => [
                        'use-ajax',
                    ],
                    'data-dialog-type' => 'modal',
                    'data-dialog-options' => Json::encode([
                        'width' => 880,
                    ]),
                ],
                'url' => $delete_url,
            ],
        ];
        $actual_operations = $controller->getOperations($entity);
        // Sort the operations to normalize link order.
        uasort($actual_operations, [
            'Drupal\\Component\\Utility\\SortArray',
            'sortByWeightElement',
        ]);
        $this->assertEquals($expected_operations, $actual_operations, 'The operations are identical.');
        // Test getOperations when label doesn't exist.
        $entity->set('label', '');
        $entity->save();
        $edit_url = $entity->toUrl()
            ->setOption('query', $this->getRedirectDestination()
            ->getAsArray());
        $edit_url->setOption('attributes', [
            'aria-label' => 'Edit ' . $entity->bundle() . ' ' . $entity->id(),
        ]);
        $delete_url = $entity->toUrl('delete-form')
            ->setOption('query', $this->getRedirectDestination()
            ->getAsArray());
        $delete_url->setOption('attributes', [
            'aria-label' => 'Delete ' . $entity->bundle() . ' ' . $entity->id(),
        ]);
        $expected_operations = [
            'edit' => [
                'title' => 'Edit',
                'weight' => 10,
                'url' => $edit_url,
            ],
            'delete' => [
                'title' => 'Delete',
                'weight' => 100,
                'attributes' => [
                    'class' => [
                        'use-ajax',
                    ],
                    'data-dialog-type' => 'modal',
                    'data-dialog-options' => Json::encode([
                        'width' => 880,
                    ]),
                ],
                'url' => $delete_url,
            ],
        ];
        $actual_operations = $controller->getOperations($entity);
        // Sort the operations to normalize link order.
        uasort($actual_operations, [
            'Drupal\\Component\\Utility\\SortArray',
            'sortByWeightElement',
        ]);
        $this->assertEquals($expected_operations, $actual_operations, 'The operations are identical.');
    }
    
    /**
     * Tests the listing UI.
     */
    public function testListUI() : void {
        // Log in as an administrative user to access the full menu trail.
        $this->drupalLogin($this->drupalCreateUser([
            'access administration pages',
            'administer site configuration',
        ]));
        // Get the list callback page.
        $this->drupalGet('admin/structure/config_test');
        // Test for the page title.
        $this->assertSession()
            ->titleEquals('Test configuration | Drupal');
        // Test for the table.
        $this->assertSession()
            ->elementsCount('xpath', '//div[@class="layout-content"]//table', 1);
        // Test the table header.
        $this->assertSession()
            ->elementsCount('xpath', '//div[@class="layout-content"]//table/thead/tr/th', 3);
        // Test the contents of each th cell.
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[1]', 'Label');
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[2]', 'Machine name');
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[3]', 'Operations');
        // Check the number of table row cells.
        $this->assertSession()
            ->elementsCount('xpath', '//div[@class="layout-content"]//table/tbody/tr[1]/td', 3);
        // Check the contents of each row cell. The first cell contains the label,
        // the second contains the machine name, and the third contains the
        // operations list.
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/tbody/tr[1]/td[1]', 'Default');
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/tbody/tr[1]/td[2]', 'dotted.default');
        $this->assertSession()
            ->elementExists('xpath', '//div[@class="layout-content"]//table/tbody/tr[1]/td[3]//ul');
        // Add a new entity using the operations link.
        $this->assertSession()
            ->linkExists('Add test configuration');
        $this->clickLink('Add test configuration');
        $this->assertSession()
            ->statusCodeEquals(200);
        $edit = [
            'label' => 'Antelope',
            'id' => 'antelope',
            'weight' => 1,
        ];
        $this->submitForm($edit, 'Save');
        // Ensure that the entity's sort method was called.
        $this->assertTrue(\Drupal::state()->get('config_entity_sort'), 'ConfigTest::sort() was called.');
        // Confirm that the user is returned to the listing, and verify that the
        // text of the label and machine name appears in the list (versus elsewhere
        // on the page).
        $this->assertSession()
            ->elementExists('xpath', '//td[text() = "Antelope"]');
        $this->assertSession()
            ->elementExists('xpath', '//td[text() = "antelope"]');
        // Edit the entity using the operations link.
        $this->assertSession()
            ->linkByHrefExists('admin/structure/config_test/manage/antelope');
        $this->clickLink('Edit', 1);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->titleEquals('Edit Antelope | Drupal');
        $edit = [
            'label' => 'Albatross',
            'id' => 'albatross',
        ];
        $this->submitForm($edit, 'Save');
        // Confirm that the user is returned to the listing, and verify that the
        // text of the label and machine name appears in the list (versus elsewhere
        // on the page).
        $this->assertSession()
            ->elementExists('xpath', '//td[text() = "Albatross"]');
        $this->assertSession()
            ->elementExists('xpath', '//td[text() = "albatross"]');
        // Delete the added entity using the operations link.
        $this->assertSession()
            ->linkByHrefExists('admin/structure/config_test/manage/albatross/delete');
        $this->clickLink('Delete', 1);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->titleEquals('Are you sure you want to delete the test configuration Albatross? | Drupal');
        $this->submitForm([], 'Delete');
        // Verify that the text of the label and machine name does not appear in
        // the list (though it may appear elsewhere on the page).
        $this->assertSession()
            ->elementNotExists('xpath', '//td[text() = "Albatross"]');
        $this->assertSession()
            ->elementNotExists('xpath', '//td[text() = "albatross"]');
        // Delete the original entity using the operations link.
        $this->clickLink('Delete');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->titleEquals('Are you sure you want to delete the test configuration Default? | Drupal');
        $this->submitForm([], 'Delete');
        // Verify that the text of the label and machine name does not appear in
        // the list (though it may appear elsewhere on the page).
        $this->assertSession()
            ->elementNotExists('xpath', '//td[text() = "Default"]');
        $this->assertSession()
            ->elementNotExists('xpath', '//td[text() = "dotted.default"]');
        // Confirm that the empty text is displayed.
        $this->assertSession()
            ->pageTextContains('There are no test configuration entities yet.');
    }
    
    /**
     * Tests paging.
     */
    public function testPager() : void {
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
        ]));
        $storage = \Drupal::service('entity_type.manager')->getListBuilder('config_test')
            ->getStorage();
        // Create 51 test entities.
        for ($i = 1; $i < 52; $i++) {
            $storage->create([
                'id' => str_pad((string) $i, 2, '0', STR_PAD_LEFT),
                'label' => 'Test config entity ' . $i,
                'weight' => $i,
                'protected_property' => $i,
            ])
                ->save();
        }
        // Load the listing page.
        $this->drupalGet('admin/structure/config_test');
        // Item 51 should not be present.
        $this->assertSession()
            ->pageTextContains('Test config entity 50');
        $this->assertSession()
            ->responseNotContains('Test config entity 51');
        // Browse to the next page, test config entity 51 is on page 2.
        $this->clickLink('Page 2');
        $this->assertSession()
            ->responseNotContains('Test config entity 50');
        $this->assertSession()
            ->responseContains('dotted.default');
        $this->assertSession()
            ->pageTextContains('Test config entity 51');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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 SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
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::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
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::tearDown protected function 3
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::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigEntityListTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigEntityListTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ConfigEntityListTest::setUp protected function Overrides BrowserTestBase::setUp
ConfigEntityListTest::testList public function Tests entity list builder methods.
ConfigEntityListTest::testListUI public function Tests the listing UI.
ConfigEntityListTest::testPager public function Tests paging.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#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::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
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. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
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 Deprecated public function Callback for random string validation.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated 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. 2
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. 5
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 Deprecated public static function Returns the database connection to the site under test.
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
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. 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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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.
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.