class BlockContentTypeTest

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

Ensures that custom block type functions work correctly.

@group block_content

Hierarchy

Expanded class hierarchy of BlockContentTypeTest

File

core/modules/block_content/tests/src/Functional/BlockContentTypeTest.php, line 15

Namespace

Drupal\Tests\block_content\Functional
View source
class BlockContentTypeTest extends BlockContentTestBase {
    use AssertBreadcrumbTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Permissions to grant admin user.
     *
     * @var array
     */
    protected $permissions = [
        'administer blocks',
        'administer block_content fields',
    ];
    
    /**
     * Whether or not to create an initial block type.
     *
     * @var bool
     */
    protected $autoCreateBasicBlockType = FALSE;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests the order of the block content types on the add page.
     */
    public function testBlockContentAddPageOrder() {
        $this->createBlockContentType([
            'id' => 'bundle_1',
            'label' => 'Bundle 1',
        ]);
        $this->createBlockContentType([
            'id' => 'bundle_2',
            'label' => 'Aaa Bundle 2',
        ]);
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('block/add');
        $this->assertSession()
            ->pageTextMatches('/Aaa Bundle 2(.*)Bundle 1/');
    }
    
    /**
     * Tests creating a block type programmatically and via a form.
     */
    public function testBlockContentTypeCreation() {
        // Log in a test user.
        $this->drupalLogin($this->adminUser);
        // Test the page with no block-types.
        $this->drupalGet('block/add');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('You have not created any block types yet');
        $this->clickLink('block type creation page');
        // Create a block type via the user interface.
        $edit = [
            'id' => 'foo',
            'label' => 'title for foo',
        ];
        $this->submitForm($edit, 'Save');
        $block_type = BlockContentType::load('foo');
        $this->assertInstanceOf(BlockContentType::class, $block_type);
        $field_definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('block_content', 'foo');
        $this->assertTrue(isset($field_definitions['body']), 'Body field created when using the UI to create block content types.');
        // Check that the block type was created in site default language.
        $default_langcode = \Drupal::languageManager()->getDefaultLanguage()
            ->getId();
        $this->assertEquals($block_type->language()
            ->getId(), $default_langcode);
        // Create block types programmatically.
        $this->createBlockContentType('basic', TRUE);
        $field_definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('block_content', 'basic');
        $this->assertTrue(isset($field_definitions['body']), "Body field for 'basic' block type created when using the testing API to create block content types.");
        $this->createBlockContentType('other');
        $field_definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('block_content', 'other');
        $this->assertFalse(isset($field_definitions['body']), "Body field for 'other' block type not created when using the testing API to create block content types.");
        $block_type = BlockContentType::load('other');
        $this->assertInstanceOf(BlockContentType::class, $block_type);
        $this->drupalGet('block/add/' . $block_type->id());
        $this->assertSession()
            ->statusCodeEquals(200);
    }
    
    /**
     * Tests editing a block type using the UI.
     */
    public function testBlockContentTypeEditing() {
        $this->drupalPlaceBlock('system_breadcrumb_block');
        // Now create an initial block-type.
        $this->createBlockContentType('basic', TRUE);
        $this->drupalLogin($this->adminUser);
        // We need two block types to prevent /block/add redirecting.
        $this->createBlockContentType('other');
        $field_definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('block_content', 'other');
        $this->assertFalse(isset($field_definitions['body']), 'Body field was not created when using the API to create block content types.');
        // Verify that title and body fields are displayed.
        $this->drupalGet('block/add/basic');
        $this->assertSession()
            ->pageTextContains('Block description');
        $this->assertNotEmpty($this->cssSelect('#edit-body-0-value'), 'Body field was found.');
        // Change the block type name.
        $edit = [
            'label' => 'Bar',
        ];
        $this->drupalGet('admin/structure/block/block-content/manage/basic');
        $this->assertSession()
            ->titleEquals('Edit basic custom block type | Drupal');
        $this->submitForm($edit, 'Save');
        $front_page_path = Url::fromRoute('<front>')->toString();
        $this->assertBreadcrumb('admin/structure/block/block-content/manage/basic/fields', [
            $front_page_path => 'Home',
            'admin/structure/block' => 'Block layout',
            'admin/structure/block/block-content' => 'Custom block library',
            'admin/structure/block/block-content/manage/basic' => 'Edit Bar',
        ]);
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        $this->drupalGet('block/add');
        $this->assertSession()
            ->pageTextContains('Bar');
        $this->clickLink('Bar');
        // Verify that the original machine name was used in the URL.
        $this->assertSession()
            ->addressEquals(Url::fromRoute('block_content.add_form', [
            'block_content_type' => 'basic',
        ]));
        // Remove the body field.
        $this->drupalGet('admin/structure/block/block-content/manage/basic/fields/block_content.basic.body/delete');
        $this->submitForm([], 'Delete');
        // Resave the settings for this type.
        $this->drupalGet('admin/structure/block/block-content/manage/basic');
        $this->submitForm([], 'Save');
        // Check that the body field doesn't exist.
        $this->drupalGet('block/add/basic');
        $this->assertEmpty($this->cssSelect('#edit-body-0-value'), 'Body field was not found.');
    }
    
    /**
     * Tests deleting a block type that still has content.
     */
    public function testBlockContentTypeDeletion() {
        // Now create an initial block-type.
        $this->createBlockContentType('basic', TRUE);
        // Create a block type programmatically.
        $type = $this->createBlockContentType('foo');
        $this->drupalLogin($this->adminUser);
        // Add a new block of this type.
        $block = $this->createBlockContent(FALSE, 'foo');
        // Attempt to delete the block type, which should not be allowed.
        $this->drupalGet('admin/structure/block/block-content/manage/' . $type->id() . '/delete');
        $this->assertSession()
            ->pageTextContains($type->label() . ' is used by 1 custom block on your site. You can not remove this block type until you have removed all of the ' . $type->label() . ' blocks.');
        $this->assertSession()
            ->pageTextNotContains('This action cannot be undone.');
        // Delete the block.
        $block->delete();
        // Attempt to delete the block type, which should now be allowed.
        $this->drupalGet('admin/structure/block/block-content/manage/' . $type->id() . '/delete');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to delete the custom block type ' . $type->id() . '?');
        $this->assertSession()
            ->pageTextContains('This action cannot be undone.');
    }
    
    /**
     * Tests that redirects work as expected when multiple block types exist.
     */
    public function testsBlockContentAddTypes() {
        // Now create an initial block-type.
        $this->createBlockContentType('basic', TRUE);
        $this->drupalLogin($this->adminUser);
        // Create two block types programmatically.
        $this->createBlockContentType('foo');
        $this->createBlockContentType('bar');
        // Get the custom block storage.
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('block_content');
        // Install all themes.
        $themes = [
            'olivero',
            'stark',
            'claro',
        ];
        \Drupal::service('theme_installer')->install($themes);
        $theme_settings = $this->config('system.theme');
        foreach ($themes as $default_theme) {
            // Change the default theme.
            $theme_settings->set('default', $default_theme)
                ->save();
            $this->drupalPlaceBlock('local_actions_block');
            // For each installed theme, go to its block page and test the redirects.
            foreach ($themes as $theme) {
                // Test that adding a block from the 'place blocks' form sends you to the
                // block configure form.
                $path = $theme == $default_theme ? 'admin/structure/block' : "admin/structure/block/list/{$theme}";
                $this->drupalGet($path);
                $this->clickLink('Place block');
                $this->clickLink('Add custom block');
                $this->clickLink('foo');
                // Create a new block.
                $edit = [
                    'info[0][value]' => $this->randomMachineName(8),
                ];
                $this->submitForm($edit, 'Save');
                $blocks = $storage->loadByProperties([
                    'info' => $edit['info[0][value]'],
                ]);
                if (!empty($blocks)) {
                    $block = reset($blocks);
                    $this->assertSession()
                        ->addressEquals(Url::fromRoute('block.admin_add', [
                        'plugin_id' => 'block_content:' . $block->uuid(),
                        'theme' => $theme,
                    ]));
                    $this->submitForm([
                        'region' => 'content',
                    ], 'Save block');
                    $this->assertSession()
                        ->addressEquals(Url::fromRoute('block.admin_display_theme', [
                        'theme' => $theme,
                    ], [
                        'query' => [
                            'block-placement' => Html::getClass($edit['info[0][value]']),
                        ],
                    ]));
                }
                else {
                    $this->fail('Could not load created block.');
                }
            }
        }
        // Test that adding a block from the 'custom blocks list' doesn't send you
        // to the block configure form.
        $this->drupalGet('admin/structure/block/block-content');
        $this->clickLink('Add custom block');
        $this->clickLink('foo');
        $edit = [
            'info[0][value]' => $this->randomMachineName(8),
        ];
        $this->submitForm($edit, 'Save');
        $blocks = $storage->loadByProperties([
            'info' => $edit['info[0][value]'],
        ]);
        if (!empty($blocks)) {
            $this->assertSession()
                ->addressEquals(Url::fromRoute('entity.block_content.collection'));
        }
        else {
            $this->fail('Could not load created block.');
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertBreadcrumbTrait::assertBreadcrumb protected function Assert that a given path shows certain breadcrumb links.
AssertBreadcrumbTrait::assertBreadcrumbParts protected function Assert that a trail exists in the internal browser.
AssertBreadcrumbTrait::getBreadcrumbParts protected function Returns the breadcrumb contents of the current page in the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
AssertMenuActiveTrailTrait::assertMenuActiveTrail protected function Assert that active trail exists in a menu tree output.
BlockContentTestBase::$adminUser protected property Admin user.
BlockContentTestBase::$profile protected property Profile to use. Overrides BrowserTestBase::$profile
BlockContentTestBase::createBlockContent protected function Creates a custom block.
BlockContentTestBase::createBlockContentType protected function Creates a custom block type (bundle).
BlockContentTypeTest::$autoCreateBasicBlockType protected property Whether or not to create an initial block type. Overrides BlockContentTestBase::$autoCreateBasicBlockType
BlockContentTypeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
BlockContentTypeTest::$modules protected static property Modules to enable. Overrides BlockContentTestBase::$modules
BlockContentTypeTest::$permissions protected property Permissions to grant admin user. Overrides BlockContentTestBase::$permissions
BlockContentTypeTest::setUp protected function Sets the test up. Overrides BlockContentTestBase::setUp
BlockContentTypeTest::testBlockContentAddPageOrder public function Tests the order of the block content types on the add page.
BlockContentTypeTest::testBlockContentTypeCreation public function Tests creating a block type programmatically and via a form.
BlockContentTypeTest::testBlockContentTypeDeletion public function Tests deleting a block type that still has content.
BlockContentTypeTest::testBlockContentTypeEditing public function Tests editing a block type using the UI.
BlockContentTypeTest::testsBlockContentAddTypes public function Tests that redirects work as expected when multiple block types exist.
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 drupal_rewrite_settings().
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::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::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 Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::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::__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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 3
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
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::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 1
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::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. 2
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
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.