class FileFieldWidgetClaroThemeTest

Same name in other branches
  1. 10 core/modules/file/tests/src/FunctionalJavascript/FileFieldWidgetClaroThemeTest.php \Drupal\Tests\file\FunctionalJavascript\FileFieldWidgetClaroThemeTest

Tests the widget visibility settings for the Claro theme.

The widget is intentionally tested with Claro as the default theme to test the changes added in _claro_preprocess_file_and_image_widget().

@group file

Hierarchy

Expanded class hierarchy of FileFieldWidgetClaroThemeTest

See also

_claro_preprocess_file_and_image_widget()

File

core/modules/file/tests/src/FunctionalJavascript/FileFieldWidgetClaroThemeTest.php, line 19

Namespace

Drupal\Tests\file\FunctionalJavascript
View source
class FileFieldWidgetClaroThemeTest extends FileFieldWidgetTest {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'claro';
    
    /**
     * Tests that the field widget visibility settings are respected on the form.
     */
    public function testWidgetDefaultVisibilitySettings() : void {
        // Set up an article node with all field storage settings set to TRUE.
        $type_name = 'article';
        $field_name = 'test_file_field_1';
        $field_storage_settings = [
            'display_field' => TRUE,
            'display_default' => TRUE,
        ];
        $field_settings = [];
        $widget_settings = [];
        $field_storage = $this->createFileField($field_name, 'node', $type_name, $field_storage_settings, $field_settings, $widget_settings);
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        $test_file = current($this->getTestFiles('text'));
        $test_file_path = \Drupal::service('file_system')->realpath($test_file->uri);
        // Fill out the form accordingly.
        $this->drupalGet("node/add/{$type_name}");
        $title = 'Fake Article Name 01';
        $page->findField('title[0][value]')
            ->setValue($title);
        $page->attachFileToField('files[' . $field_name . '_0]', $test_file_path);
        $remove_button = $assert_session->waitForElementVisible('css', '[name="' . $field_name . '_0_remove_button"]');
        $this->assertNotNull($remove_button);
        $type = $assert_session->fieldExists("{$field_name}[0][display]")
            ->getAttribute('type');
        $this->assertEquals($type, 'checkbox');
        $assert_session->checkboxChecked("{$field_name}[0][display]");
        // Now, submit the same form and ensure that value is retained.
        $this->submitForm([], 'Save');
        $node = $this->drupalGetNodeByTitle($title, TRUE);
        $this->assertEquals(1, $node->get($field_name)
            ->getValue()[0]['display'], 'The checkbox is enabled.');
        $this->drupalGet(Url::fromRoute('entity.node.edit_form', [
            'node' => $node->id(),
        ]));
        $assert_session->checkboxChecked("{$field_name}[0][display]");
        // Submit the form again with the disabled value of the checkbox.
        $this->submitForm([
            "{$field_name}[0][display]" => FALSE,
        ], 'Save');
        $node = $this->drupalGetNodeByTitle($title, TRUE);
        $this->assertEquals(0, $node->get($field_name)
            ->getValue()[0]['display'], 'The checkbox is disabled.');
        $this->drupalGet(Url::fromRoute('entity.node.edit_form', [
            'node' => $node->id(),
        ]));
        $assert_session->checkboxNotChecked("{$field_name}[0][display]");
        // Disable the field settings and ensure that the form is updated.
        $field_storage->setSetting('display_default', FALSE);
        $field_storage->save();
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        $this->drupalGet("node/add/{$type_name}");
        $title = 'Fake Article Name 02';
        $page->findField('title[0][value]')
            ->setValue($title);
        $page->attachFileToField('files[' . $field_name . '_0]', $test_file_path);
        $remove_button = $assert_session->waitForElementVisible('css', '[name="' . $field_name . '_0_remove_button"]');
        $this->assertNotNull($remove_button);
        $type = $assert_session->fieldExists("{$field_name}[0][display]")
            ->getAttribute('type');
        $this->assertEquals($type, 'checkbox');
        $assert_session->checkboxNotChecked("{$field_name}[0][display]");
        // Submit the same form and ensure that value is retained.
        $this->submitForm([], 'Save');
        $node = $this->drupalGetNodeByTitle($title, TRUE);
        $this->assertEquals(0, $node->get($field_name)
            ->getValue()[0]['display'], 'The checkbox is disabled.');
        $this->drupalGet(Url::fromRoute('entity.node.edit_form', [
            'node' => $node->id(),
        ]));
        $assert_session->checkboxNotChecked("{$field_name}[0][display]");
        // Check the checkbox and ensure that it is submitted properly.
        $this->submitForm([
            "{$field_name}[0][display]" => TRUE,
        ], 'Save');
        $node = $this->drupalGetNodeByTitle($title, TRUE);
        $this->assertEquals(1, $node->get($field_name)
            ->getValue()[0]['display'], 'The checkbox is disabled because display_default option is marked as false.');
        $this->drupalGet(Url::fromRoute('entity.node.edit_form', [
            'node' => $node->id(),
        ]));
        $assert_session->checkboxChecked("{$field_name}[0][display]");
    }

}

Members

Title Sort descending 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::$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::$profile protected property The profile to install as a basis for testing. 41
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::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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::assertTableHeaderExistsByLabel protected function Asserts that a header cell appears on a table.
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.
FileFieldCreationTrait::attachFileField protected function Attaches a file field to an entity.
FileFieldCreationTrait::createFileField protected function Creates a new file field.
FileFieldWidgetClaroThemeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides FileFieldWidgetTest::$defaultTheme
FileFieldWidgetClaroThemeTest::testWidgetDefaultVisibilitySettings public function Tests that the field widget visibility settings are respected on the form.
FileFieldWidgetTest::$adminUser protected property An user with administration permissions.
FileFieldWidgetTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
FileFieldWidgetTest::getTestFile public function Retrieves a sample file of the specified type.
FileFieldWidgetTest::setUp protected function Overrides BrowserTestBase::setUp
FileFieldWidgetTest::testMultiValuedWidget public function Tests upload and remove buttons for multiple multi-valued File fields.
FileFieldWidgetTest::testSingleValuedWidget public function Tests uploading and remove buttons for a single-valued File field.
FileFieldWidgetTest::testUploadingMoreFilesThanAllowed public function Tests uploading more files than allowed at once.
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. 8
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. 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. 29
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
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
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.
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile protected static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
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. 3
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::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.