class DisplayBlockTest

Same name in other branches
  1. 9 core/modules/block/tests/src/Functional/Views/DisplayBlockTest.php \Drupal\Tests\block\Functional\Views\DisplayBlockTest
  2. 10 core/modules/block/tests/src/Functional/Views/DisplayBlockTest.php \Drupal\Tests\block\Functional\Views\DisplayBlockTest
  3. 11.x core/modules/block/tests/src/Functional/Views/DisplayBlockTest.php \Drupal\Tests\block\Functional\Views\DisplayBlockTest

Tests the block display plugin.

@group block

Hierarchy

Expanded class hierarchy of DisplayBlockTest

See also

\Drupal\views\Plugin\views\display\Block

File

core/modules/block/tests/src/Functional/Views/DisplayBlockTest.php, line 24

Namespace

Drupal\Tests\block\Functional\Views
View source
class DisplayBlockTest extends ViewTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    use AssertBlockAppearsTrait;
    
    /**
     * Modules to install.
     *
     * @var array
     */
    public static $modules = [
        'node',
        'block_test_views',
        'test_page_test',
        'contextual',
        'views_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'classy';
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view_block',
        'test_view_block2',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE) {
        parent::setUp($import_test_views);
        ViewTestData::createTestViews(get_class($this), [
            'block_test_views',
        ]);
        $this->enableViewsTestModule();
    }
    
    /**
     * Tests default and custom block categories.
     */
    public function testBlockCategory() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
            'administer blocks',
        ]));
        // Create a new view in the UI.
        $edit = [];
        $edit['label'] = $this->randomString();
        $edit['id'] = strtolower($this->randomMachineName());
        $edit['show[wizard_key]'] = 'standard:views_test_data';
        $edit['description'] = $this->randomString();
        $edit['block[create]'] = TRUE;
        $edit['block[style][row_plugin]'] = 'fields';
        $this->drupalPostForm('admin/structure/views/add', $edit, t('Save and edit'));
        $pattern = '//tr[.//td[text()=:category] and .//td//a[contains(@href, :href)]]';
        // Test that the block was given a default category corresponding to its
        // base table.
        $arguments = [
            ':href' => Url::fromRoute('block.admin_add', [
                'plugin_id' => 'views_block:' . $edit['id'] . '-block_1',
                'theme' => 'classy',
            ])->toString(),
            ':category' => 'Lists (Views)',
        ];
        $this->drupalGet('admin/structure/block');
        $this->clickLink('Place block');
        $elements = $this->xpath($pattern, $arguments);
        $this->assertTrue(!empty($elements), 'The test block appears in the category for its base table.');
        // Duplicate the block before changing the category.
        $this->drupalPostForm('admin/structure/views/view/' . $edit['id'] . '/edit/block_1', [], t('Duplicate @display_title', [
            '@display_title' => 'Block',
        ]));
        $this->assertUrl('admin/structure/views/view/' . $edit['id'] . '/edit/block_2');
        // Change the block category to a random string.
        $this->drupalGet('admin/structure/views/view/' . $edit['id'] . '/edit/block_1');
        $link = $this->xpath('//a[@id="views-block-1-block-category" and normalize-space(text())=:category]', $arguments);
        $this->assertTrue(!empty($link));
        $this->clickLink(t('Lists (Views)'));
        $category = $this->randomString();
        $this->drupalPostForm(NULL, [
            'block_category' => $category,
        ], t('Apply'));
        // Duplicate the block after changing the category.
        $this->drupalPostForm(NULL, [], t('Duplicate @display_title', [
            '@display_title' => 'Block',
        ]));
        $this->assertUrl('admin/structure/views/view/' . $edit['id'] . '/edit/block_3');
        $this->drupalPostForm(NULL, [], t('Save'));
        // Test that the blocks are listed under the correct categories.
        $arguments[':category'] = $category;
        $this->drupalGet('admin/structure/block');
        $this->clickLink('Place block');
        $elements = $this->xpath($pattern, $arguments);
        $this->assertTrue(!empty($elements), 'The test block appears in the custom category.');
        $arguments = [
            ':href' => Url::fromRoute('block.admin_add', [
                'plugin_id' => 'views_block:' . $edit['id'] . '-block_2',
                'theme' => 'classy',
            ])->toString(),
            ':category' => 'Lists (Views)',
        ];
        $elements = $this->xpath($pattern, $arguments);
        $this->assertTrue(!empty($elements), 'The first duplicated test block remains in the original category.');
        $arguments = [
            ':href' => Url::fromRoute('block.admin_add', [
                'plugin_id' => 'views_block:' . $edit['id'] . '-block_3',
                'theme' => 'classy',
            ])->toString(),
            ':category' => $category,
        ];
        $elements = $this->xpath($pattern, $arguments);
        $this->assertTrue(!empty($elements), 'The second duplicated test block appears in the custom category.');
    }
    
    /**
     * Tests removing a block display.
     */
    public function testDeleteBlockDisplay() {
        // To test all combinations possible we first place create two instances
        // of the block display of the first view.
        $block_1 = $this->drupalPlaceBlock('views_block:test_view_block-block_1', [
            'label' => 'test_view_block-block_1:1',
        ]);
        $block_2 = $this->drupalPlaceBlock('views_block:test_view_block-block_1', [
            'label' => 'test_view_block-block_1:2',
        ]);
        // Then we add one instance of blocks for each of the two displays of the
        // second view.
        $block_3 = $this->drupalPlaceBlock('views_block:test_view_block2-block_1', [
            'label' => 'test_view_block2-block_1',
        ]);
        $block_4 = $this->drupalPlaceBlock('views_block:test_view_block2-block_2', [
            'label' => 'test_view_block2-block_2',
        ]);
        $this->drupalGet('test-page');
        $this->assertBlockAppears($block_1);
        $this->assertBlockAppears($block_2);
        $this->assertBlockAppears($block_3);
        $this->assertBlockAppears($block_4);
        $block_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('block');
        // Remove the block display, so both block entities from the first view
        // should both disappear.
        $view = Views::getView('test_view_block');
        $view->initDisplay();
        $view->displayHandlers
            ->remove('block_1');
        $view->storage
            ->save();
        $this->assertNull($block_storage->load($block_1->id()), 'The block for this display was removed.');
        $this->assertNull($block_storage->load($block_2->id()), 'The block for this display was removed.');
        $this->assertNotEmpty($block_storage->load($block_3->id()), 'A block from another view was unaffected.');
        $this->assertNotEmpty($block_storage->load($block_4->id()), 'A block from another view was unaffected.');
        $this->drupalGet('test-page');
        $this->assertNoBlockAppears($block_1);
        $this->assertNoBlockAppears($block_2);
        $this->assertBlockAppears($block_3);
        $this->assertBlockAppears($block_4);
        // Remove the first block display of the second view and ensure the block
        // instance of the second block display still exists.
        $view = Views::getView('test_view_block2');
        $view->initDisplay();
        $view->displayHandlers
            ->remove('block_1');
        $view->storage
            ->save();
        $this->assertNull($block_storage->load($block_3->id()), 'The block for this display was removed.');
        $this->assertNotEmpty($block_storage->load($block_4->id()), 'A block from another display on the same view was unaffected.');
        $this->drupalGet('test-page');
        $this->assertNoBlockAppears($block_3);
        $this->assertBlockAppears($block_4);
    }
    
    /**
     * Test the block form for a Views block.
     */
    public function testViewsBlockForm() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer blocks',
        ]));
        $default_theme = $this->config('system.theme')
            ->get('default');
        $this->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
        $elements = $this->xpath('//input[@name="label"]');
        $this->assertTrue(empty($elements), 'The label field is not found for Views blocks.');
        // Test that the machine name field is hidden from display and has been
        // saved as expected from the default value.
        $this->assertNoFieldById('edit-machine-name', 'views_block__test_view_block_1', 'The machine name is hidden on the views block form.');
        // Save the block.
        $edit = [
            'region' => 'content',
        ];
        $this->drupalPostForm(NULL, $edit, t('Save block'));
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('block');
        $block = $storage->load('views_block__test_view_block_block_1');
        // This will only return a result if our new block has been created with the
        // expected machine name.
        $this->assertTrue(!empty($block), 'The expected block was loaded.');
        for ($i = 2; $i <= 3; $i++) {
            // Place the same block again and make sure we have a new ID.
            $this->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
            $block = $storage->load('views_block__test_view_block_block_1_' . $i);
            // This will only return a result if our new block has been created with the
            // expected machine name.
            $this->assertTrue(!empty($block), 'The expected block was loaded.');
        }
        // Tests the override capability of items per page.
        $this->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
        $edit = [
            'region' => 'content',
        ];
        $edit['settings[override][items_per_page]'] = 10;
        $this->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
        $block = $storage->load('views_block__test_view_block_block_1_4');
        $config = $block->getPlugin()
            ->getConfiguration();
        $this->assertEqual(10, $config['items_per_page'], "'Items per page' is properly saved.");
        $edit['settings[override][items_per_page]'] = 5;
        $this->drupalPostForm('admin/structure/block/manage/views_block__test_view_block_block_1_4', $edit, t('Save block'));
        $block = $storage->load('views_block__test_view_block_block_1_4');
        $config = $block->getPlugin()
            ->getConfiguration();
        $this->assertEqual(5, $config['items_per_page'], "'Items per page' is properly saved.");
        // Tests the override of the label capability.
        $edit = [
            'region' => 'content',
        ];
        $edit['settings[views_label_checkbox]'] = 1;
        $edit['settings[views_label]'] = 'Custom title';
        $this->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
        $block = $storage->load('views_block__test_view_block_block_1_5');
        $config = $block->getPlugin()
            ->getConfiguration();
        $this->assertEqual('Custom title', $config['views_label'], "'Label' is properly saved.");
    }
    
    /**
     * Tests the actual rendering of the views block.
     */
    public function testBlockRendering() {
        // Create a block and set a custom title.
        $block = $this->drupalPlaceBlock('views_block:test_view_block-block_1', [
            'label' => 'test_view_block-block_1:1',
            'views_label' => 'Custom title',
        ]);
        $this->drupalGet('');
        $result = $this->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
        $this->assertEqual($result[0]->getText(), 'Custom title');
        // Don't override the title anymore.
        $plugin = $block->getPlugin();
        $plugin->setConfigurationValue('views_label', '');
        $block->save();
        $this->drupalGet('');
        $result = $this->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
        $this->assertEqual($result[0]->getText(), 'test_view_block');
        // Hide the title.
        $block->getPlugin()
            ->setConfigurationValue('label_display', FALSE);
        $block->save();
        $this->drupalGet('');
        $result = $this->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
        $this->assertTrue(empty($result), 'The title is not visible.');
        $this->assertCacheTags(array_merge($block->getCacheTags(), [
            'block_view',
            'config:block_list',
            'config:system.site',
            'config:views.view.test_view_block',
            'http_response',
            'rendered',
        ]));
    }
    
    /**
     * Tests the various testcases of empty block rendering.
     */
    public function testBlockEmptyRendering() {
        $url = new Url('test_page_test.test_page');
        // Remove all views_test_data entries.
        \Drupal::database()->truncate('views_test_data')
            ->execute();
        
        /** @var \Drupal\views\ViewEntityInterface $view */
        $view = View::load('test_view_block');
        $view->invalidateCaches();
        $block = $this->drupalPlaceBlock('views_block:test_view_block-block_1', [
            'label' => 'test_view_block-block_1:1',
            'views_label' => 'Custom title',
        ]);
        $this->drupalGet('');
        $this->assertCount(1, $this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]'));
        $display =& $view->getDisplay('block_1');
        $display['display_options']['block_hide_empty'] = TRUE;
        $view->save();
        $this->drupalGet($url);
        $this->assertCount(0, $this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]'));
        // Ensure that the view cacheability metadata is propagated even, for an
        // empty block.
        $this->assertCacheTags(array_merge($block->getCacheTags(), [
            'block_view',
            'config:block_list',
            'config:views.view.test_view_block',
            'http_response',
            'rendered',
        ]));
        $this->assertCacheContexts([
            'url.query_args:_wrapper_format',
        ]);
        // Add a header displayed on empty result.
        $display =& $view->getDisplay('block_1');
        $display['display_options']['defaults']['header'] = FALSE;
        $display['display_options']['header']['example'] = [
            'field' => 'area_text_custom',
            'id' => 'area_text_custom',
            'table' => 'views',
            'plugin_id' => 'text_custom',
            'content' => 'test header',
            'empty' => TRUE,
        ];
        $view->save();
        $this->drupalGet($url);
        $this->assertCount(1, $this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]'));
        $this->assertCacheTags(array_merge($block->getCacheTags(), [
            'block_view',
            'config:block_list',
            'config:views.view.test_view_block',
            'http_response',
            'rendered',
        ]));
        $this->assertCacheContexts([
            'url.query_args:_wrapper_format',
        ]);
        // Hide the header on empty results.
        $display =& $view->getDisplay('block_1');
        $display['display_options']['defaults']['header'] = FALSE;
        $display['display_options']['header']['example'] = [
            'field' => 'area_text_custom',
            'id' => 'area_text_custom',
            'table' => 'views',
            'plugin_id' => 'text_custom',
            'content' => 'test header',
            'empty' => FALSE,
        ];
        $view->save();
        $this->drupalGet($url);
        $this->assertCount(0, $this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]'));
        $this->assertCacheTags(array_merge($block->getCacheTags(), [
            'block_view',
            'config:block_list',
            'config:views.view.test_view_block',
            'http_response',
            'rendered',
        ]));
        $this->assertCacheContexts([
            'url.query_args:_wrapper_format',
        ]);
        // Add an empty text.
        $display =& $view->getDisplay('block_1');
        $display['display_options']['defaults']['empty'] = FALSE;
        $display['display_options']['empty']['example'] = [
            'field' => 'area_text_custom',
            'id' => 'area_text_custom',
            'table' => 'views',
            'plugin_id' => 'text_custom',
            'content' => 'test empty',
        ];
        $view->save();
        $this->drupalGet($url);
        $this->assertCount(1, $this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]'));
        $this->assertCacheTags(array_merge($block->getCacheTags(), [
            'block_view',
            'config:block_list',
            'config:views.view.test_view_block',
            'http_response',
            'rendered',
        ]));
        $this->assertCacheContexts([
            'url.query_args:_wrapper_format',
        ]);
    }
    
    /**
     * Tests the contextual links on a Views block.
     */
    public function testBlockContextualLinks() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
            'access contextual links',
            'administer blocks',
        ]));
        $block = $this->drupalPlaceBlock('views_block:test_view_block-block_1');
        $cached_block = $this->drupalPlaceBlock('views_block:test_view_block-block_1');
        $this->drupalGet('test-page');
        $id = 'block:block=' . $block->id() . ':langcode=en|entity.view.edit_form:view=test_view_block:location=block&name=test_view_block&display_id=block_1&langcode=en';
        $id_token = Crypt::hmacBase64($id, Settings::getHashSalt() . $this->container
            ->get('private_key')
            ->get());
        $cached_id = 'block:block=' . $cached_block->id() . ':langcode=en|entity.view.edit_form:view=test_view_block:location=block&name=test_view_block&display_id=block_1&langcode=en';
        $cached_id_token = Crypt::hmacBase64($cached_id, Settings::getHashSalt() . $this->container
            ->get('private_key')
            ->get());
        // @see \Drupal\contextual\Tests\ContextualDynamicContextTest:assertContextualLinkPlaceHolder()
        $this->assertRaw('<div' . new Attribute([
            'data-contextual-id' => $id,
            'data-contextual-token' => $id_token,
        ]) . '></div>', new FormattableMarkup('Contextual link placeholder with id @id exists.', [
            '@id' => $id,
        ]));
        $this->assertRaw('<div' . new Attribute([
            'data-contextual-id' => $cached_id,
            'data-contextual-token' => $cached_id_token,
        ]) . '></div>', new FormattableMarkup('Contextual link placeholder with id @id exists.', [
            '@id' => $cached_id,
        ]));
        // Get server-rendered contextual links.
        // @see \Drupal\contextual\Tests\ContextualDynamicContextTest:renderContextualLinks()
        $post = [
            'ids[0]' => $id,
            'ids[1]' => $cached_id,
            'tokens[0]' => $id_token,
            'tokens[1]' => $cached_id_token,
        ];
        $url = 'contextual/render?_format=json,destination=test-page';
        $this->getSession()
            ->getDriver()
            ->getClient()
            ->request('POST', $url, $post);
        $this->assertSession()
            ->statusCodeEquals(200);
        $json = Json::decode($this->getSession()
            ->getPage()
            ->getContent());
        $this->assertIdentical($json[$id], '<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $block->id() . '">Configure block</a></li><li class="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>');
        $this->assertIdentical($json[$cached_id], '<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $cached_block->id() . '">Configure block</a></li><li class="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertBlockAppearsTrait::assertBlockAppears protected function Checks to see whether a block appears on the page.
AssertBlockAppearsTrait::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
AssertBlockAppearsTrait::findBlockInstance protected function Find a block instance on the page.
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&#039;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
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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::$minkDefaultDriverClass protected property 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. 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::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 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.
1
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::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::tearDown protected function 3
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
DisplayBlockTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DisplayBlockTest::$modules public static property Modules to install. Overrides ViewTestBase::$modules
DisplayBlockTest::$testViews public static property Views used by this test.
DisplayBlockTest::setUp protected function Overrides ViewTestBase::setUp
DisplayBlockTest::testBlockCategory public function Tests default and custom block categories.
DisplayBlockTest::testBlockContextualLinks public function Tests the contextual links on a Views block.
DisplayBlockTest::testBlockEmptyRendering public function Tests the various testcases of empty block rendering.
DisplayBlockTest::testBlockRendering public function Tests the actual rendering of the views block.
DisplayBlockTest::testDeleteBlockDisplay public function Tests removing a block display.
DisplayBlockTest::testViewsBlockForm public function Test the block form for a Views block.
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 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::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. 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::assertSession public function Returns WebAssert object. 1
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view with debugging.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::viewsData protected function Returns the views data definition. 8
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.