class ManageDisplayTest

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

Tests the Field UI "Manage display" and "Manage form display" screens.

@group field_ui

Hierarchy

Expanded class hierarchy of ManageDisplayTest

File

core/modules/field_ui/tests/src/FunctionalJavascript/ManageDisplayTest.php, line 18

Namespace

Drupal\Tests\field_ui\FunctionalJavascript
View source
class ManageDisplayTest extends WebDriverTestBase {
    use FieldUiTestTrait;
    use FieldUiJSTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'field_ui',
        'field_test',
        'field_third_party_test',
        'block',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * @var string
     */
    protected $type;
    
    /**
     * @var \Drupal\Core\Entity\entityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $displayStorage;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('system_breadcrumb_block');
        // Create a test user.
        $admin_user = $this->drupalCreateUser([
            'access content',
            'administer content types',
            'administer node fields',
            'administer node form display',
            'administer node display',
            'administer users',
            'administer account settings',
            'administer user display',
            'bypass node access',
        ]);
        $this->drupalLogin($admin_user);
        // Create content type, with underscores.
        $type_name = $this->randomMachineName(8) . '_test';
        $type = $this->drupalCreateContentType([
            'name' => $type_name,
            'type' => $type_name,
        ]);
        $this->type = $type->id();
        $this->entityTypeManager = $this->container
            ->get('entity_type.manager');
    }
    
    /**
     * Tests formatter settings.
     */
    public function testFormatterUI() : void {
        $manage_fields = 'admin/structure/types/manage/' . $this->type;
        $manage_display = $manage_fields . '/display';
        // Create a field, and a node with some data for the field.
        $this->fieldUIAddNewFieldJS($manage_fields, 'test', 'Test field');
        $display_id = 'node.' . $this->type . '.default';
        $displayStorage = $this->entityTypeManager
            ->getStorage('entity_view_display');
        // Get the display options (formatter and settings) that were automatically
        // assigned for the 'default' display.
        
        /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
        $display = $displayStorage->loadUnchanged($display_id);
        $display_options = $display->getComponent('field_test');
        $format = $display_options['type'];
        $default_settings = \Drupal::service('plugin.manager.field.formatter')->getDefaultSettings($format);
        $setting_name = key($default_settings);
        $setting_value = $display_options['settings'][$setting_name];
        // Display the "Manage display" screen and check that the expected formatter
        // is selected.
        $this->drupalGet($manage_display);
        $session = $this->getSession();
        $assert_session = $this->assertSession();
        $page = $session->getPage();
        // Find commonly used elements in this test.
        $button_save = $page->findButton('Save');
        $field_test_format_type = $page->findField('fields[field_test][type]');
        $field_test_drag_handle = $page->find('css', '#field-test .tabledrag-handle');
        $field_test_settings = $page->find('css', 'input[name="field_test_settings_edit"]');
        $weight_toggle = $page->find('css', '.tabledrag-toggle-weight');
        // Assert the format type field is visible and contains the expected
        // formatter.
        $this->assertTrue($field_test_format_type->isVisible());
        $this->assertEquals($format, $field_test_format_type->getValue());
        $assert_session->responseContains("{$setting_name}: {$setting_value}");
        // Validate the selectbox.
        $this->assertFieldSelectOptions($field_test_format_type, [
            'field_no_settings',
            'field_empty_test',
            'field_empty_setting',
            'field_test_default',
            'field_test_multiple',
            'field_test_with_prepare_view',
            'field_test_applicable',
        ]);
        // Ensure that fields can be hidden directly by dragging the element.
        $target = $page->find('css', '.region-hidden-message');
        $field_test_drag_handle->dragTo($target);
        $assert_session->assertExpectedAjaxRequest(1);
        $button_save->click();
        // Validate the changed display settings on the server.
        
        /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
        $display = $displayStorage->loadUnchanged($display_id);
        $this->assertNull($display->getComponent('field_test'));
        // Switch to manual mode.
        $weight_toggle->click();
        $field_region = $page->findField('fields[field_test][region]');
        // Change the region to content using the region field.
        $this->assertEquals('hidden', $field_region->getValue());
        $field_region->setValue('content');
        // Confirm the region element retains focus after the AJAX update completes.
        $this->assertJsCondition('document.activeElement === document.querySelector("[name=\'fields[field_test][region]\']")');
        $button_save->click();
        // Change the format for the test field.
        $field_test_format_type->setValue('field_test_multiple');
        $assert_session->assertExpectedAjaxRequest(1);
        // Confirm the format element retains focus after the AJAX update completes.
        $this->assertJsCondition('document.activeElement === document.querySelector("[name=\'fields[field_test][type]\']")');
        $plugin_summary = $page->find('css', '#field-test .field-plugin-summary');
        $this->assertStringContainsString("test_formatter_setting_multiple: dummy test string", $plugin_summary->getText(), 'The expected summary is displayed.');
        // Submit the form and assert that
        // hook_field_formatter_settings_summary_alter() is called.
        $button_save->click();
        $assert_session->responseContains('field_test_field_formatter_settings_summary_alter');
        // Open the settings form for the test field.
        $field_test_settings->click();
        $assert_session->assertExpectedAjaxRequest(1);
        // Assert that the field added in
        // field_test_field_formatter_third_party_settings_form() is present.
        $field_third_party = $page->findField('fields[field_test][settings_edit_form][third_party_settings][field_third_party_test][field_test_field_formatter_third_party_settings_form]');
        $this->assertNotEmpty($field_third_party, 'The field added in hook_field_formatter_third_party_settings_form() is present on the settings form.');
        // Change the value and submit the form to save the third party settings.
        $field_third_party->setValue('foo');
        $page->findButton('Update')
            ->click();
        $assert_session->assertExpectedAjaxRequest(2);
        $button_save->click();
        // Assert the third party settings.
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        $this->drupalGet($manage_display);
        $id = 'node.' . $this->type . '.default';
        
        /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
        $display = $displayStorage->loadUnchanged($id);
        $this->assertEquals('foo', $display->getRenderer('field_test')
            ->getThirdPartySetting('field_third_party_test', 'field_test_field_formatter_third_party_settings_form'));
        $this->assertContains('field_third_party_test', $display->calculateDependencies()
            ->getDependencies()['module'], 'The display has a dependency on field_third_party_test module.');
        // Change the formatter to an empty setting and validate it's initialized
        // correctly.
        $field_test_format_type = $page->findField('fields[field_test][type]');
        $field_test_format_type->setValue('field_empty_setting');
        $assert_session->assertExpectedAjaxRequest(1);
        $assert_session->responseNotContains('Default empty setting now has a value.');
        $this->assertTrue($field_test_settings->isVisible());
        // Set the empty_setting option to a non-empty value again and validate
        // the formatting summary now display's this correctly.
        $field_test_settings->click();
        $assert_session->assertExpectedAjaxRequest(2);
        $field_empty_setting = $page->findField('fields[field_test][settings_edit_form][settings][field_empty_setting]');
        $field_empty_setting->setValue('non empty setting');
        $page->findButton('Update')
            ->click();
        $assert_session->assertExpectedAjaxRequest(3);
        $assert_session->responseContains('Default empty setting now has a value.');
        // Test the settings form behavior. An edit button should be present since
        // there are third party settings to configure.
        $field_test_format_type->setValue('field_no_settings');
        $this->assertTrue($field_test_settings->isVisible());
        // Make sure we can save the third party settings when there are no settings
        // available.
        $field_test_settings->click();
        $assert_session->assertExpectedAjaxRequest(4);
        $page->findButton('Update')
            ->click();
        // When a module providing third-party settings to a formatter (or widget)
        // is uninstalled, the formatter remains enabled but the provided settings,
        // together with the corresponding form elements, are removed from the
        // display component.
        \Drupal::service('module_installer')->uninstall([
            'field_third_party_test',
        ]);
        // Ensure the button is still there after the module has been disabled.
        $this->drupalGet($manage_display);
        $this->assertTrue($field_test_settings->isVisible());
        // Ensure that third-party form elements are not present anymore.
        $field_test_settings->click();
        $assert_session->assertExpectedAjaxRequest(1);
        $field_third_party = $page->findField('fields[field_test][settings_edit_form][third_party_settings][field_third_party_test][field_test_field_formatter_third_party_settings_form]');
        $this->assertEmpty($field_third_party);
        // Ensure that third-party settings were removed from the formatter.
        
        /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
        $display = $displayStorage->loadUnchanged($display_id);
        $component = $display->getComponent('field_test');
        $this->assertArrayNotHasKey('field_third_party_test', $component['third_party_settings']);
    }
    
    /**
     * Tests widget settings.
     */
    public function testWidgetUI() : void {
        // Admin Manage Fields page.
        $manage_fields = 'admin/structure/types/manage/' . $this->type;
        // Admin Manage Display page.
        $manage_display = $manage_fields . '/form-display';
        $form_storage = $this->entityTypeManager
            ->getStorage('entity_form_display');
        // Creates a new field that can be used with multiple formatters.
        // Reference: Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidgetMultiple::isApplicable().
        $this->fieldUIAddNewFieldJS($manage_fields, 'test', 'Test field');
        // Get the display options (formatter and settings) that were automatically
        // assigned for the 'default' display.
        
        /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $display */
        $display = $form_storage->loadUnchanged("node.{$this->type}.default");
        $display_options = $display->getComponent('field_test');
        $widget_type = $display_options['type'];
        $default_settings = \Drupal::service('plugin.manager.field.widget')->getDefaultSettings($widget_type);
        $setting_name = key($default_settings);
        $setting_value = $display_options['settings'][$setting_name];
        // Display the "Manage form display" screen and check if the expected
        // widget is selected.
        $this->drupalGet($manage_display);
        $session = $this->getSession();
        $assert_session = $this->assertSession();
        $page = $session->getPage();
        $field_test_settings = $page->find('css', 'input[name="field_test_settings_edit"]');
        $field_test_type = $page->findField('fields[field_test][type]');
        $button_save = $page->findButton('Save');
        $this->assertEquals($widget_type, $field_test_type->getValue(), 'The expected widget is selected.');
        $assert_session->responseContains("{$setting_name}: {$setting_value}");
        // Check whether widget weights are respected.
        $this->assertFieldSelectOptions($field_test_type, [
            'test_field_widget',
            'test_field_widget_multilingual',
            'test_field_widget_multiple',
        ]);
        $field_test_type->setValue('test_field_widget_multiple');
        $assert_session->assertExpectedAjaxRequest(1);
        $button_save->click();
        $this->drupalGet($manage_display);
        $widget_type = 'test_field_widget_multiple';
        $default_settings = \Drupal::service('plugin.manager.field.widget')->getDefaultSettings($widget_type);
        $setting_name = key($default_settings);
        $setting_value = $default_settings[$setting_name];
        $this->assertEquals($widget_type, $field_test_type->getValue(), 'The expected widget is selected.');
        $assert_session->responseContains("{$setting_name}: {$setting_value}");
        $button_save->click();
        
        /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $display */
        $display = $form_storage->loadUnchanged("node.{$this->type}.default");
        $display_options = $display->getComponent('field_test');
        $current_widget = $display_options['type'];
        $current_setting_value = $display_options['settings'][$setting_name];
        $this->assertEquals($current_widget, $widget_type, 'The widget was updated.');
        $this->assertEquals($current_setting_value, $setting_value, 'The setting was updated.');
        // Assert that hook_field_widget_settings_summary_alter() is called.
        $assert_session->responseContains('field_test_field_widget_settings_summary_alter');
        $field_test_settings->click();
        $assert_session->assertExpectedAjaxRequest(1);
        // Assert that the field added in
        // field_test_field_widget_third_party_settings_form() is present.
        $field_third_party_test = $page->findField('fields[field_test][settings_edit_form][third_party_settings][field_third_party_test][field_test_widget_third_party_settings_form]');
        $this->assertNotEmpty($field_third_party_test, 'The field added in hook_field_widget_third_party_settings_form() is present on the settings form.');
        $field_third_party_test->setValue('foo');
        $page->findButton('Update')
            ->click();
        $assert_session->assertWaitOnAjaxRequest();
        $button_save->click();
        $this->drupalGet($manage_display);
        // Assert the third party settings.
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        
        /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $display */
        $display = $form_storage->loadUnchanged('node.' . $this->type . '.default');
        $this->assertEquals('foo', $display->getRenderer('field_test')
            ->getThirdPartySetting('field_third_party_test', 'field_test_widget_third_party_settings_form'));
        $this->assertContains('field_third_party_test', $display->calculateDependencies()
            ->getDependencies()['module'], 'Form display does not have a dependency on field_third_party_test module.');
        // Creates a new field that can not be used with the multiple formatter.
        // Reference: Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidgetMultiple::isApplicable().
        $this->fieldUIAddNewFieldJS($manage_fields, 'onewidgetfield', 'One Widget Field');
        // Go to the Manage Form Display.
        $this->drupalGet($manage_display);
        $field_onewidgetfield_type = $page->findField('fields[field_onewidgetfield][type]');
        $field_test_drag_handle = $page->find('css', '#field-test .tabledrag-handle');
        $field_region = $page->findField('fields[field_test][region]');
        $weight_toggle = $page->find('css', '.tabledrag-toggle-weight');
        $target = $page->find('css', '.region-hidden-message');
        // Checks if the select elements contain the specified options.
        $this->assertFieldSelectOptions($field_test_type, [
            'test_field_widget',
            'test_field_widget_multilingual',
            'test_field_widget_multiple',
        ]);
        $this->assertFieldSelectOptions($field_onewidgetfield_type, [
            'test_field_widget',
            'test_field_widget_multilingual',
        ]);
        $field_test_drag_handle->dragTo($target);
        $assert_session->assertWaitOnAjaxRequest();
        $button_save->click();
        // Validate the changed display settings on the server.
        
        /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $display */
        $display = $form_storage->loadUnchanged("node.{$this->type}.default");
        $this->assertNull($display->getComponent('field_test'));
        // Switch to manual mode.
        $weight_toggle->click();
        // Change the region to content using the region field.
        $this->assertEquals('hidden', $field_region->getValue());
        $field_region->setValue('content');
        $button_save->click();
        // Validate the change on the server.
        $this->drupalGet($manage_display);
        $display = EntityFormDisplay::load("node.{$this->type}.default");
        $this->assertNotNull($display->getComponent('field_test'));
    }
    
    /**
     * Checks if a select element contains the specified options.
     *
     * @param \Behat\Mink\Element\NodeElement $field
     *   The select field to validate.
     * @param array $expected_options
     *   An array of expected options.
     * @param string|null $selected
     *   The default value to validate.
     *
     * @internal
     */
    protected function assertFieldSelectOptions(NodeElement $field, array $expected_options, ?string $selected = NULL) : void {
        
        /** @var \Behat\Mink\Element\NodeElement[] $select_options */
        $select_options = $field->findAll('xpath', 'option');
        // Validate the number of options.
        $this->assertSameSize($expected_options, $select_options);
        // Validate the options and expected order.
        foreach ($select_options as $key => $option) {
            $this->assertEquals($option->getAttribute('value'), $expected_options[$key]);
        }
        // Validate the default value if passed.
        if (!is_null($selected)) {
            $this->assertEquals($selected, $field->getValue());
        }
    }
    
    /**
     * Confirms that notifications to save appear when necessary.
     */
    public function testNotAppliedUntilSavedWarning() : void {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        // Admin Manage Fields page.
        $manage_fields = 'admin/structure/types/manage/' . $this->type;
        $this->fieldUIAddNewFieldJS($manage_fields, 'test', 'Test field');
        $manage_display = 'admin/structure/types/manage/' . $this->type . '/display';
        $manage_form = 'admin/structure/types/manage/' . $this->type . '/form-display';
        // Form display, change widget type.
        $this->drupalGet($manage_form);
        $assert_session->elementNotExists('css', '.tabledrag-changed-warning');
        $assert_session->elementNotExists('css', 'abbr.tabledrag-changed');
        $page->selectFieldOption('fields[uid][type]', 'options_buttons');
        $this->assertNotNull($changed_warning = $assert_session->waitForElementVisible('css', '.tabledrag-changed-warning'));
        $this->assertNotNull($assert_session->waitForElementVisible('css', ' #uid abbr.tabledrag-changed'));
        $this->assertSame('* You have unsaved changes.', $changed_warning->getText());
        // Form display, change widget settings.
        $this->drupalGet($manage_form);
        $edit_widget_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-uid-settings-edit"]');
        $edit_widget_button->press();
        $assert_session->waitForText('3rd party formatter settings form');
        // Confirm the AJAX operation of opening the form does not result in the row
        // being set as changed. New settings must be submitted for that to happen.
        $assert_session->elementNotExists('css', 'abbr.tabledrag-changed');
        $cancel_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-uid-settings-edit-form-actions-cancel-settings"]');
        $cancel_button->press();
        $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-fields-uid-settings-edit-form-actions-cancel-settings"]');
        $assert_session->elementNotExists('css', '.tabledrag-changed-warning');
        $assert_session->elementNotExists('css', 'abbr.tabledrag-changed');
        $edit_widget_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-uid-settings-edit"]');
        $edit_widget_button->press();
        $widget_field = $assert_session->waitForField('fields[uid][settings_edit_form][third_party_settings][field_third_party_test][field_test_widget_third_party_settings_form]');
        $widget_field->setValue('honk');
        $update_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-uid-settings-edit-form-actions-save-settings"]');
        $update_button->press();
        $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-fields-field-test-settings-edit-form-actions-cancel-settings"]');
        $this->assertNotNull($changed_warning = $assert_session->waitForElementVisible('css', '.tabledrag-changed-warning'));
        $this->assertNotNull($assert_session->waitForElementVisible('css', ' #uid abbr.tabledrag-changed'));
        $this->assertSame('* You have unsaved changes.', $changed_warning->getText());
        // Content display, change formatter type.
        $this->drupalGet($manage_display);
        $assert_session->elementNotExists('css', '.tabledrag-changed-warning');
        $assert_session->elementNotExists('css', 'abbr.tabledrag-changed');
        $page->selectFieldOption('edit-fields-field-test-label', 'inline');
        $this->assertNotNull($changed_warning = $assert_session->waitForElementVisible('css', '.tabledrag-changed-warning'));
        $this->assertNotNull($assert_session->waitForElementVisible('css', ' #field-test abbr.tabledrag-changed'));
        $this->assertSame('* You have unsaved changes.', $changed_warning->getText());
        // Content display, change formatter settings.
        $this->drupalGet($manage_display);
        $assert_session->elementNotExists('css', '.tabledrag-changed-warning');
        $assert_session->elementNotExists('css', 'abbr.tabledrag-changed');
        $edit_formatter_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-field-test-settings-edit"]');
        $edit_formatter_button->press();
        $assert_session->waitForText('3rd party formatter settings form');
        $cancel_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-field-test-settings-edit-form-actions-cancel-settings"]');
        $cancel_button->press();
        $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-fields-field-test-settings-edit-form-actions-cancel-settings"]');
        $assert_session->elementNotExists('css', '.tabledrag-changed-warning');
        $assert_session->elementNotExists('css', 'abbr.tabledrag-changed');
        $edit_formatter_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-field-test-settings-edit"]');
        $edit_formatter_button->press();
        $formatter_field = $assert_session->waitForField('fields[field_test][settings_edit_form][third_party_settings][field_third_party_test][field_test_field_formatter_third_party_settings_form]');
        $formatter_field->setValue('honk');
        $update_button = $assert_session->waitForElementVisible('css', '[data-drupal-selector="edit-fields-field-test-settings-edit-form-actions-save-settings"]');
        $update_button->press();
        $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-fields-field-test-settings-edit-form-actions-cancel-settings"]');
        $this->assertNotNull($changed_warning = $assert_session->waitForElementVisible('css', '.tabledrag-changed-warning'));
        $this->assertNotNull($assert_session->waitForElementVisible('css', ' #field-test abbr.tabledrag-changed'));
        $this->assertSame('* You have unsaved changes.', $changed_warning->getText());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
FieldUiJSTestTrait::fieldUIAddExistingFieldJS public function Adds an existing field through the Field UI.
FieldUiJSTestTrait::fieldUIAddNewFieldJS public function Creates a new field through the Field UI.
FieldUiJSTestTrait::getFieldFromGroupJS public function Helper function that returns the field card element if it is in a group.
FieldUiTestTrait::assertFieldDoesNotExist protected function Asserts that the field doesn't exist in the overview form.
FieldUiTestTrait::assertFieldDoesNotExistOnOverview protected function Asserts that the field does not appear on the overview form.
FieldUiTestTrait::assertFieldExistsOnOverview protected function Asserts that the field appears on the overview form.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
FieldUiTestTrait::getFieldFromGroup public function Helper function that returns the name of the group that a field is in.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
ManageDisplayTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ManageDisplayTest::$displayStorage protected property
ManageDisplayTest::$entityTypeManager protected property
ManageDisplayTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ManageDisplayTest::$type protected property
ManageDisplayTest::assertFieldSelectOptions protected function Checks if a select element contains the specified options.
ManageDisplayTest::setUp protected function Overrides BrowserTestBase::setUp
ManageDisplayTest::testFormatterUI public function Tests formatter settings.
ManageDisplayTest::testNotAppliedUntilSavedWarning public function Confirms that notifications to save appear when necessary.
ManageDisplayTest::testWidgetUI public function Tests widget settings.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors protected function Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.