class ExposedFormUITest

Same name in other branches
  1. 8.9.x core/modules/views_ui/tests/src/Functional/ExposedFormUITest.php \Drupal\Tests\views_ui\Functional\ExposedFormUITest
  2. 10 core/modules/views_ui/tests/src/Functional/ExposedFormUITest.php \Drupal\Tests\views_ui\Functional\ExposedFormUITest
  3. 11.x core/modules/views_ui/tests/src/Functional/ExposedFormUITest.php \Drupal\Tests\views_ui\Functional\ExposedFormUITest

Tests exposed forms UI functionality.

@group views_ui

Hierarchy

Expanded class hierarchy of ExposedFormUITest

File

core/modules/views_ui/tests/src/Functional/ExposedFormUITest.php, line 12

Namespace

Drupal\Tests\views_ui\Functional
View source 
class ExposedFormUITest extends UITestBase {
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_exposed_admin_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'views_ui',
        'block',
        'taxonomy',
        'field_ui',
        'datetime',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Array of error message strings raised by the grouped form.
     *
     * @var array
     *
     * @see FilterPluginBase::buildGroupValidate
     */
    protected $groupFormUiErrors = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->drupalCreateContentType([
            'type' => 'article',
        ]);
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        // Create some random nodes.
        for ($i = 0; $i < 5; $i++) {
            $this->drupalCreateNode();
        }
        // Error strings used in the grouped filter form validation.
        $this->groupFormUiErrors['missing_value'] = 'A value is required if the label for this item is defined.';
        $this->groupFormUiErrors['missing_title'] = 'A label is required if the value for this item is defined.';
        $this->groupFormUiErrors['missing_title_empty_operator'] = 'A label is required for the specified operator.';
    }
    
    /**
     * Tests the admin interface of exposed filter and sort items.
     */
    public function testExposedAdminUi() {
        $edit = [];
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        // Be sure that the button is called exposed.
        $this->helperButtonHasLabel('edit-options-expose-button-button', 'Expose filter');
        // The first time the filter UI is displayed, the operator and the
        // value forms should be shown.
        $this->assertSession()
            ->fieldValueEquals('edit-options-operator-in', 'in');
        $this->assertSession()
            ->fieldValueEquals('edit-options-operator-not-in', 'in');
        $this->assertSession()
            ->checkboxNotChecked('edit-options-value-page');
        $this->assertSession()
            ->checkboxNotChecked('edit-options-value-article');
        // Click the Expose filter button.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm($edit, 'Expose filter');
        // Check the label of the expose button.
        $this->helperButtonHasLabel('edit-options-expose-button-button', 'Hide filter');
        // After exposing the filter, Operator and Value should be still here.
        $this->assertSession()
            ->fieldValueEquals('edit-options-operator-in', 'in');
        $this->assertSession()
            ->fieldValueEquals('edit-options-operator-not-in', 'in');
        $this->assertSession()
            ->checkboxNotChecked('edit-options-value-page');
        $this->assertSession()
            ->checkboxNotChecked('edit-options-value-article');
        // Check the validations of the filter handler.
        $edit = [];
        $edit['options[expose][identifier]'] = '';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains('The identifier is required if the filter is exposed.');
        $edit = [];
        $edit['options[expose][identifier]'] = 'value';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains('This identifier is not allowed.');
        // Now check the sort criteria.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/sort/created');
        $this->helperButtonHasLabel('edit-options-expose-button-button', 'Expose sort');
        $this->assertSession()
            ->fieldNotExists('edit-options-expose-label');
        $this->assertSession()
            ->fieldNotExists('Sort field identifier');
        // Un-expose the filter.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm([], 'Hide filter');
        // After Un-exposing the filter, Operator and Value should be shown again.
        $this->assertSession()
            ->fieldValueEquals('edit-options-operator-in', 'in');
        $this->assertSession()
            ->fieldValueEquals('edit-options-operator-not-in', 'in');
        $this->assertSession()
            ->checkboxNotChecked('edit-options-value-page');
        $this->assertSession()
            ->checkboxNotChecked('edit-options-value-article');
        // Click the Expose sort button.
        $edit = [];
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/sort/created');
        $this->submitForm($edit, 'Expose sort');
        // Check the label of the expose button.
        $this->helperButtonHasLabel('edit-options-expose-button-button', 'Hide sort');
        $this->assertSession()
            ->fieldValueEquals('edit-options-expose-label', 'Authored on');
        $this->assertSession()
            ->fieldValueEquals('Sort field identifier', 'created');
        // Test adding a new exposed sort criteria.
        $view_id = $this->randomView()['id'];
        $this->drupalGet("admin/structure/views/nojs/add-handler/{$view_id}/default/sort");
        $this->submitForm([
            'name[node_field_data.created]' => 1,
        ], 'Add and configure sort criteria');
        $this->assertSession()
            ->fieldValueEquals('options[order]', 'ASC');
        // Change the order and expose the sort.
        $this->submitForm([
            'options[order]' => 'DESC',
        ], 'Apply');
        $this->drupalGet("admin/structure/views/nojs/handler/{$view_id}/default/sort/created");
        $this->submitForm([], 'Expose sort');
        $this->assertSession()
            ->fieldValueEquals('options[order]', 'DESC');
        $this->assertSession()
            ->fieldValueEquals('options[expose][label]', 'Authored on');
        $this->assertSession()
            ->fieldValueEquals('Sort field identifier', 'created');
        // Change the label and try with an empty identifier.
        $edit = [
            'options[expose][label]' => $this->randomString(),
            'options[expose][field_identifier]' => '',
        ];
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains('Sort field identifier field is required.');
        // Try with an invalid identifier.
        $edit['options[expose][field_identifier]'] = 'abc&! ###08.';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains('This identifier has illegal characters.');
        // Use a valid identifier.
        $edit['options[expose][field_identifier]'] = $this->randomMachineName() . '_-~.';
        $this->submitForm($edit, 'Apply');
        $this->submitForm([], 'Save');
        // Check that the values were saved.
        $display = View::load($view_id)->getDisplay('default');
        $this->assertTrue($display['display_options']['sorts']['created']['exposed']);
        $this->assertSame([
            'label' => $edit['options[expose][label]'],
            'field_identifier' => $edit['options[expose][field_identifier]'],
        ], $display['display_options']['sorts']['created']['expose']);
        $this->assertSame('DESC', $display['display_options']['sorts']['created']['order']);
        // Test the identifier uniqueness.
        $this->drupalGet("admin/structure/views/nojs/handler/{$view_id}/default/sort/created_1");
        $this->submitForm([], 'Expose sort');
        $this->submitForm([
            'options[expose][field_identifier]' => $edit['options[expose][field_identifier]'],
        ], 'Apply');
        $this->assertSession()
            ->pageTextContains('This identifier is already used by Content: Authored on sort handler.');
    }
    
    /**
     * Tests the admin interface of exposed grouped filters.
     */
    public function testGroupedFilterAdminUi() {
        $edit = [];
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        // Click the Expose filter button.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm($edit, 'Expose filter');
        // Check the label of the grouped filters button.
        $this->helperButtonHasLabel('edit-options-group-button-button', 'Grouped filters');
        // Click the Grouped Filters button.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm([], 'Grouped filters');
        // After click on 'Grouped Filters', the standard operator and value should
        // not be displayed.
        $this->assertSession()
            ->fieldNotExists('edit-options-operator-in');
        $this->assertSession()
            ->fieldNotExists('edit-options-operator-not-in');
        $this->assertSession()
            ->fieldNotExists('edit-options-value-page');
        $this->assertSession()
            ->fieldNotExists('edit-options-value-article');
        // Check that after click on 'Grouped Filters', a new button is shown to
        // add more items to the list.
        $this->helperButtonHasLabel('edit-options-group-info-add-group', 'Add another item');
        // Validate a single entry for a grouped filter.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $edit = [];
        $edit["options[group_info][group_items][1][title]"] = 'Is Article';
        $edit["options[group_info][group_items][1][value][article]"] = 'article';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/test_exposed_admin_ui/edit/default');
        $this->assertNoGroupedFilterErrors();
        // Validate multiple entries for grouped filters.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $edit = [];
        $edit["options[group_info][group_items][1][title]"] = 'Is Article';
        $edit["options[group_info][group_items][1][value][article]"] = 'article';
        $edit["options[group_info][group_items][2][title]"] = 'Is Page';
        $edit["options[group_info][group_items][2][value][page]"] = 'page';
        $edit["options[group_info][group_items][3][title]"] = 'Is Page and Article';
        $edit["options[group_info][group_items][3][value][article]"] = 'article';
        $edit["options[group_info][group_items][3][value][page]"] = 'page';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/test_exposed_admin_ui/edit/default');
        $this->assertNoGroupedFilterErrors();
        // Validate an "is empty" filter -- title without value is valid.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/body_value');
        $edit = [];
        $edit["options[group_info][group_items][1][title]"] = 'No body';
        $edit["options[group_info][group_items][1][operator]"] = 'empty';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/test_exposed_admin_ui/edit/default');
        $this->assertNoGroupedFilterErrors();
        // Ensure the string "0" can be used as a value for numeric filters.
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_exposed_admin_ui/default/filter');
        $this->submitForm([
            'name[node_field_data.nid]' => TRUE,
        ], 'Add and configure filter criteria');
        $this->submitForm([], 'Expose filter');
        $this->submitForm([], 'Grouped filters');
        $edit = [];
        $edit['options[group_info][group_items][1][title]'] = 'Testing zero';
        $edit['options[group_info][group_items][1][operator]'] = '>';
        $edit['options[group_info][group_items][1][value][value]'] = '0';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/test_exposed_admin_ui/edit/default');
        $this->assertNoGroupedFilterErrors();
        // Ensure "between" filters validate correctly.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/nid');
        $edit['options[group_info][group_items][1][title]'] = 'ID between test';
        $edit['options[group_info][group_items][1][operator]'] = 'between';
        $edit['options[group_info][group_items][1][value][min]'] = '0';
        $edit['options[group_info][group_items][1][value][max]'] = '10';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/test_exposed_admin_ui/edit/default');
        $this->assertNoGroupedFilterErrors();
    }
    public function testGroupedFilterAdminUiErrors() {
        // Select the empty operator without a title specified.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/body_value');
        $edit = [];
        $edit["options[group_info][group_items][1][title]"] = '';
        $edit["options[group_info][group_items][1][operator]"] = 'empty';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains($this->groupFormUiErrors['missing_title_empty_operator']);
        // Specify a title without a value.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm([], 'Expose filter');
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm([], 'Grouped filters');
        $edit = [];
        $edit["options[group_info][group_items][1][title]"] = 'Is Article';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains($this->groupFormUiErrors['missing_value']);
        // Specify a value without a title.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $edit = [];
        $edit["options[group_info][group_items][1][title]"] = '';
        $edit["options[group_info][group_items][1][value][article]"] = 'article';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains($this->groupFormUiErrors['missing_title']);
    }
    
    /**
     * Asserts that there are no Grouped Filters errors.
     *
     * @param string $message
     *   The assert message.
     *
     * @internal
     */
    protected function assertNoGroupedFilterErrors(string $message = '') : void {
        foreach ($this->groupFormUiErrors as $error) {
            if (empty($message)) {
                $this->assertSession()
                    ->responseNotContains($error);
            }
        }
    }
    
    /**
     * Tests the configuration of grouped exposed filters.
     */
    public function testExposedGroupedFilter() {
        // Click the Expose filter button.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm([], 'Expose filter');
        // Select 'Grouped filters' radio button.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $this->submitForm([], 'Grouped filters');
        // Add 3 groupings.
        $edit = [
            'options[group_button][radios][radios]' => 1,
            'options[group_info][group_items][1][title]' => '1st',
            'options[group_info][group_items][1][value][all]' => 'all',
            'options[group_info][group_items][2][title]' => '2nd',
            'options[group_info][group_items][2][value][article]' => 'article',
            'options[group_info][group_items][3][title]' => '3rd',
            'options[group_info][group_items][3][value][page]' => 'page',
            'options[group_info][default_group]' => '3',
        ];
        // Apply the filter settings.
        $this->submitForm($edit, 'Apply');
        // Check that the view is saved without errors.
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Check the default filter value.
        $this->drupalGet('test_exposed_admin_ui');
        $this->assertSession()
            ->fieldValueEquals('type', '3');
        // Enable "Allow multiple selections" option and set a default group.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/type');
        $edit['options[group_info][multiple]'] = 1;
        $edit['options[group_info][default_group_multiple][1]'] = 1;
        $this->submitForm($edit, 'Apply');
        $this->submitForm([], 'Save');
        // Check the default filter values again.
        $this->drupalGet('test_exposed_admin_ui');
        $this->assertSession()
            ->checkboxChecked('type[1]');
        $this->assertSession()
            ->checkboxNotChecked('type[2]');
        $this->assertSession()
            ->checkboxNotChecked('type[3]');
        // Click the Expose filter button.
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_exposed_admin_ui/default/filter');
        $this->submitForm([
            'name[node_field_data.status]' => 1,
        ], 'Add and configure filter criteria');
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/status');
        $this->submitForm([], 'Expose filter');
        // Select 'Grouped filters' radio button.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/status');
        $this->submitForm([], 'Grouped filters');
        // Add 3 groupings.
        $edit = [
            'options[group_button][radios][radios]' => 1,
            'options[group_info][group_items][1][title]' => 'Any',
            'options[group_info][group_items][1][value]' => 'All',
            'options[group_info][group_items][2][title]' => 'Published',
            'options[group_info][group_items][2][value]' => 1,
            'options[group_info][group_items][3][title]' => 'Unpublished',
            'options[group_info][group_items][3][value]' => 0,
            'options[group_info][default_group]' => 2,
        ];
        // Apply the filter settings.
        $this->submitForm($edit, 'Apply');
        // Check that the view is saved without errors.
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/status');
        // Assert the same settings defined before still are there.
        $this->assertSession()
            ->checkboxChecked('edit-options-group-info-group-items-1-value-all');
        $this->assertSession()
            ->checkboxChecked('edit-options-group-info-group-items-2-value-1');
        $this->assertSession()
            ->checkboxChecked('edit-options-group-info-group-items-3-value-0');
        // Check the default filter value.
        $this->drupalGet('test_exposed_admin_ui');
        $this->assertSession()
            ->fieldValueEquals('status', '2');
        // Enable "Allow multiple selections" option and set a default group.
        $this->drupalGet('admin/structure/views/nojs/handler/test_exposed_admin_ui/default/filter/status');
        $edit['options[group_info][multiple]'] = 1;
        $edit['options[group_info][default_group_multiple][3]'] = 1;
        $this->submitForm($edit, 'Apply');
        $this->submitForm([], 'Save');
        // Check the default filter value again.
        $this->drupalGet('test_exposed_admin_ui');
        $this->assertSession()
            ->checkboxNotChecked('status[1]');
        $this->assertSession()
            ->checkboxNotChecked('status[2]');
        $this->assertSession()
            ->checkboxChecked('status[3]');
    }

}

Members

Title Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
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
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::$profile protected property The profile to install as a basis for testing. 37
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
ExposedFormUITest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ExposedFormUITest::$groupFormUiErrors protected property Array of error message strings raised by the grouped form.
ExposedFormUITest::$modules protected static property Modules to enable. Overrides UITestBase::$modules
ExposedFormUITest::$testViews public static property Views used by this test.
ExposedFormUITest::assertNoGroupedFilterErrors protected function Asserts that there are no Grouped Filters errors.
ExposedFormUITest::setUp protected function Sets up the test. Overrides UITestBase::setUp
ExposedFormUITest::testExposedAdminUi public function Tests the admin interface of exposed filter and sort items.
ExposedFormUITest::testExposedGroupedFilter public function Tests the configuration of grouped exposed filters.
ExposedFormUITest::testGroupedFilterAdminUi public function Tests the admin interface of exposed grouped filters.
ExposedFormUITest::testGroupedFilterAdminUiErrors public function
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::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.
UITestBase::$adminUser protected property An admin user with the &#039;administer views&#039; permission. 5
UITestBase::$fullAdminUser protected property An admin user with administrative permissions for views, blocks, and nodes.
UITestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. Overrides UiHelperTrait::drupalGet
UITestBase::randomView public function A helper method which creates a random view.
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. 2
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
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. 2
ViewTestBase::viewsData protected function Returns the views data definition. 9
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.