class MultipleWidgetFormTest

Same name in other branches
  1. 11.x core/modules/field/tests/src/Functional/MultipleWidgetFormTest.php \Drupal\Tests\field\Functional\MultipleWidgetFormTest

Tests field form handling.

@group field

Hierarchy

Expanded class hierarchy of MultipleWidgetFormTest

File

core/modules/field/tests/src/Functional/MultipleWidgetFormTest.php, line 18

Namespace

Drupal\Tests\field\Functional
View source
class MultipleWidgetFormTest extends FieldTestBase {
    
    /**
     * Modules to install.
     *
     * Locale is installed so that TranslatableMarkup actually does something.
     *
     * @var array
     */
    protected static $modules = [
        'field_test',
        'options',
        'entity_test',
        'locale',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * An array of values defining a field multiple.
     *
     * @var array
     */
    protected $fieldStorageMultiple;
    
    /**
     * An array of values defining a field.
     *
     * @var array
     */
    protected $field;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $web_user = $this->drupalCreateUser([
            'view test entity',
            'administer entity_test content',
            'administer entity_test fields',
        ]);
        $this->drupalLogin($web_user);
        $this->fieldStorageMultiple = [
            'field_name' => 'field_multiple',
            'entity_type' => 'entity_test',
            'type' => 'test_field',
            'cardinality' => 4,
        ];
        $this->field = [
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
            'label' => $this->randomMachineName() . '_label',
            'description' => '[site:name]_description',
            'weight' => mt_rand(0, 127),
            'settings' => [
                'test_field_setting' => $this->randomMachineName(),
            ],
        ];
    }
    
    /**
     * Tests widgets handling multiple values.
     */
    public function testFieldFormMultipleWidget() : void {
        // Create a field with fixed cardinality, configure the form to use a
        // "multiple" widget.
        $field_storage = $this->fieldStorageMultiple;
        $field_name = $field_storage['field_name'];
        $this->field['field_name'] = $field_name;
        FieldStorageConfig::create($field_storage)->save();
        FieldConfig::create($this->field)
            ->save();
        $form = \Drupal::service('entity_display.repository')->getFormDisplay($this->field['entity_type'], $this->field['bundle'], 'default')
            ->setComponent($field_name, [
            'type' => 'test_field_widget_multiple',
        ]);
        $form->save();
        $session = $this->assertSession();
        // Display creation form.
        $this->drupalGet('entity_test/add');
        $this->assertSession()
            ->fieldValueEquals($field_name, '');
        // Create entity with three values.
        $edit = [
            $field_name => '1, 2, 3',
        ];
        $this->submitForm($edit, 'Save');
        preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
        $id = $match[1];
        // Check that the values were saved.
        $entity_init = EntityTest::load($id);
        $this->assertFieldValues($entity_init, $field_name, [
            1,
            2,
            3,
        ]);
        // Display the form, check that the values are correctly filled in.
        $this->drupalGet('entity_test/manage/' . $id . '/edit');
        $this->assertSession()
            ->fieldValueEquals($field_name, '1, 2, 3');
        // Submit the form with more values than the field accepts.
        $edit = [
            $field_name => '1, 2, 3, 4, 5',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('this field cannot hold more than 4 values');
        // Check that the field values were not submitted.
        $this->assertFieldValues($entity_init, $field_name, [
            1,
            2,
            3,
        ]);
        // Check that Attributes are rendered on the multivalue container if it is
        // a multiple widget form.
        $form->setComponent($field_name, [
            'type' => 'entity_reference_autocomplete',
        ])
            ->save();
        $this->drupalGet('entity_test/manage/' . $id . '/edit');
        $name = str_replace('_', '-', $field_name);
        $session->responseContains('data-drupal-selector="edit-' . $name . '"');
    }
    
    /**
     * Tests the form display of the label for multi-value fields.
     */
    public function testLabelOnMultiValueFields() : void {
        $user = $this->drupalCreateUser([
            'administer entity_test content',
        ]);
        $this->drupalLogin($user);
        // Ensure that the 'bar' bundle exists, to avoid config validation errors.
        entity_test_create_bundle('bar', entity_type: 'entity_test_base_field_display');
        FieldStorageConfig::create([
            'entity_type' => 'entity_test_base_field_display',
            'field_name' => 'foo',
            'type' => 'text',
            'cardinality' => FieldStorageConfig::CARDINALITY_UNLIMITED,
        ])->save();
        FieldConfig::create([
            'entity_type' => 'entity_test_base_field_display',
            'bundle' => 'bar',
            'field_name' => 'foo',
            // Set a dangerous label to test XSS filtering.
'label' => "<script>alert('a configurable field');</script>",
        ])->save();
        EntityFormDisplay::create([
            'targetEntityType' => 'entity_test_base_field_display',
            'bundle' => 'bar',
            'mode' => 'default',
        ])->setComponent('foo', [
            'type' => 'text_textfield',
        ])
            ->enable()
            ->save();
        $entity = EntityTestBaseFieldDisplay::create([
            'type' => 'bar',
        ]);
        $entity->save();
        $this->drupalGet('entity_test_base_field_display/manage/' . $entity->id());
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('A field with multiple values');
        // Test if labels were XSS filtered.
        $this->assertSession()
            ->assertEscaped("<script>alert('a configurable field');</script>");
    }
    
    /**
     * Tests hook_field_widget_complete_form_alter().
     */
    public function testFieldFormMultipleWidgetAlter() : void {
        $this->widgetAlterTest('hook_field_widget_complete_form_alter', 'test_field_widget_multiple');
    }
    
    /**
     * Tests hook_field_widget_complete_form_alter() with single value elements.
     */
    public function testFieldFormMultipleWidgetAlterSingleValues() : void {
        $this->widgetAlterTest('hook_field_widget_complete_form_alter', 'test_field_widget_multiple_single_value');
    }
    
    /**
     * Tests hook_field_widget_complete_WIDGET_TYPE_form_alter().
     */
    public function testFieldFormMultipleWidgetTypeAlter() : void {
        $this->widgetAlterTest('hook_field_widget_complete_WIDGET_TYPE_form_alter', 'test_field_widget_multiple');
    }
    
    /**
     * Tests hook_field_widget_complete_WIDGET_TYPE_form_alter() with single value elements.
     */
    public function testFieldFormMultipleWidgetTypeAlterSingleValues() : void {
        $this->widgetAlterTest('hook_field_widget_complete_WIDGET_TYPE_form_alter', 'test_field_widget_multiple_single_value');
    }
    
    /**
     * Tests widget alter hooks for a given hook name.
     */
    protected function widgetAlterTest($hook, $widget) {
        // Create a field with fixed cardinality, configure the form to use a
        // "multiple" widget.
        $field_storage = $this->fieldStorageMultiple;
        $field_name = $field_storage['field_name'];
        $this->field['field_name'] = $field_name;
        FieldStorageConfig::create($field_storage)->save();
        FieldConfig::create($this->field)
            ->save();
        // Set a flag in state so that the hook implementations will run.
        \Drupal::state()->set("field_test.widget_alter_test", [
            'hook' => $hook,
            'field_name' => $field_name,
            'widget' => $widget,
        ]);
        \Drupal::service('entity_display.repository')->getFormDisplay($this->field['entity_type'], $this->field['bundle'], 'default')
            ->setComponent($field_name, [
            'type' => $widget,
        ])
            ->save();
        // We need to rebuild hook information after setting the component through
        // the API.
        $this->rebuildAll();
        $this->drupalGet('entity_test/add');
        $this->assertSession()
            ->pageTextMatchesCount(1, '/From ' . $hook . '.* prefix on ' . $field_name . ' parent element\\./');
        if ($widget === 'test_field_widget_multiple_single_value') {
            $suffix_text = "From {$hook}(): suffix on {$field_name} child element.";
            $this->assertEquals($field_storage['cardinality'], substr_count($this->getTextContent(), $suffix_text), "'{$suffix_text}' was found {$field_storage['cardinality']} times  using widget {$widget}");
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
FieldTestBase::assertFieldValues public function Assert that a field has the expected values in an entity.
FieldTestBase::_generateTestFieldValues public function Generate random values for a field_test field.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
MultipleWidgetFormTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MultipleWidgetFormTest::$field protected property An array of values defining a field.
MultipleWidgetFormTest::$fieldStorageMultiple protected property An array of values defining a field multiple.
MultipleWidgetFormTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
MultipleWidgetFormTest::setUp protected function Overrides BrowserTestBase::setUp
MultipleWidgetFormTest::testFieldFormMultipleWidget public function Tests widgets handling multiple values.
MultipleWidgetFormTest::testFieldFormMultipleWidgetAlter public function Tests hook_field_widget_complete_form_alter().
MultipleWidgetFormTest::testFieldFormMultipleWidgetAlterSingleValues public function Tests hook_field_widget_complete_form_alter() with single value elements.
MultipleWidgetFormTest::testFieldFormMultipleWidgetTypeAlter public function Tests hook_field_widget_complete_WIDGET_TYPE_form_alter().
MultipleWidgetFormTest::testFieldFormMultipleWidgetTypeAlterSingleValues public function Tests hook_field_widget_complete_WIDGET_TYPE_form_alter() with single value elements.
MultipleWidgetFormTest::testLabelOnMultiValueFields public function Tests the form display of the label for multi-value fields.
MultipleWidgetFormTest::widgetAlterTest protected function Tests widget alter hooks for a given hook name.
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::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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