class FileFieldDisplayTest

Same name in other branches
  1. 9 core/modules/file/tests/src/Functional/FileFieldDisplayTest.php \Drupal\Tests\file\Functional\FileFieldDisplayTest
  2. 8.9.x core/modules/file/tests/src/Functional/FileFieldDisplayTest.php \Drupal\Tests\file\Functional\FileFieldDisplayTest
  3. 10 core/modules/file/tests/src/Functional/FileFieldDisplayTest.php \Drupal\Tests\file\Functional\FileFieldDisplayTest

Tests the display of file fields in node and views.

@group file

Hierarchy

Expanded class hierarchy of FileFieldDisplayTest

File

core/modules/file/tests/src/Functional/FileFieldDisplayTest.php, line 17

Namespace

Drupal\Tests\file\Functional
View source
class FileFieldDisplayTest extends FileFieldTestBase {
    use FieldUiTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests normal formatter display on node display.
     */
    public function testNodeDisplay() : void {
        $field_name = $this->randomMachineName();
        $type_name = 'article';
        $field_storage_settings = [
            'display_field' => '1',
            'display_default' => '1',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ];
        $field_settings = [
            'description_field' => '1',
        ];
        $widget_settings = [];
        $this->createFileField($field_name, 'node', $type_name, $field_storage_settings, $field_settings, $widget_settings);
        // Create a new node *without* the file field set, and check that the field
        // is not shown for each node display.
        $node = $this->drupalCreateNode([
            'type' => $type_name,
        ]);
        // Check file_default last as the assertions below assume that this is the
        // case.
        $file_formatters = [
            'file_table',
            'file_url_plain',
            'hidden',
            'file_default',
        ];
        foreach ($file_formatters as $formatter) {
            if ($formatter === 'hidden') {
                $edit = [
                    "fields[{$field_name}][region]" => 'hidden',
                ];
            }
            else {
                $edit = [
                    "fields[{$field_name}][type]" => $formatter,
                    "fields[{$field_name}][region]" => 'content',
                ];
            }
            $this->drupalGet("admin/structure/types/manage/{$type_name}/display");
            $this->submitForm($edit, 'Save');
            $this->drupalGet('node/' . $node->id());
            // Verify that the field label is hidden when no file is attached.
            $this->assertSession()
                ->pageTextNotContains($field_name);
        }
        $this->generateFile('escaped-&-text', 64, 10, 'text');
        $test_file = File::create([
            'uri' => 'public://escaped-&-text.txt',
            'name' => 'escaped-&-text',
            'filesize' => filesize('public://escaped-&-text.txt'),
        ]);
        // Create a new node with the uploaded file.
        $nid = $this->uploadNodeFile($test_file, $field_name, $type_name);
        // Check that the default formatter is displaying with the file name.
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $node_storage->resetCache([
            $nid,
        ]);
        $node = $node_storage->load($nid);
        $node_file = File::load($node->{$field_name}->target_id);
        $file_link = [
            '#theme' => 'file_link',
            '#file' => $node_file,
        ];
        $default_output = \Drupal::service('renderer')->renderRoot($file_link);
        $this->assertSession()
            ->responseContains($default_output);
        // Turn the "display" option off and check that the file is no longer displayed.
        $edit = [
            $field_name . '[0][display]' => FALSE,
        ];
        $this->drupalGet('node/' . $nid . '/edit');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->responseNotContains($default_output);
        // Add a description and make sure that it is displayed.
        $description = $this->randomMachineName();
        $edit = [
            $field_name . '[0][description]' => $description,
            $field_name . '[0][display]' => TRUE,
        ];
        $this->drupalGet('node/' . $nid . '/edit');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains($description);
        // Ensure the filename in the link's title attribute is escaped.
        $this->assertSession()
            ->responseContains('title="escaped-&-text.txt"');
        // Test that fields appear as expected after during the preview.
        // Add a second file.
        $name = 'files[' . $field_name . '_1][]';
        $edit_upload[$name] = \Drupal::service('file_system')->realpath($test_file->getFileUri());
        $this->drupalGet("node/{$nid}/edit");
        $this->submitForm($edit_upload, 'Upload');
        // Uncheck the display checkboxes and go to the preview.
        $edit[$field_name . '[0][display]'] = FALSE;
        $edit[$field_name . '[1][display]'] = FALSE;
        $this->submitForm($edit, 'Preview');
        $this->clickLink('Back to content editing');
        // First file.
        $this->assertSession()
            ->responseContains($field_name . '[0][display]');
        // Second file.
        $this->assertSession()
            ->responseContains($field_name . '[1][display]');
        $this->assertSession()
            ->responseContains($field_name . '[1][description]');
        // Check that the file fields don't contain duplicate HTML IDs.
        $this->assertSession()
            ->pageContainsNoDuplicateId();
    }
    
    /**
     * Tests default display of File Field.
     */
    public function testDefaultFileFieldDisplay() : void {
        $field_name = $this->randomMachineName();
        $type_name = 'article';
        $field_storage_settings = [
            'display_field' => '1',
            'display_default' => '0',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ];
        $field_settings = [
            'description_field' => '1',
        ];
        $widget_settings = [];
        $this->createFileField($field_name, 'node', $type_name, $field_storage_settings, $field_settings, $widget_settings);
        $test_file = $this->getTestFile('text');
        // Create a new node with the uploaded file.
        $nid = $this->uploadNodeFile($test_file, $field_name, $type_name);
        $this->drupalGet('node/' . $nid . '/edit');
        $this->assertSession()
            ->fieldExists($field_name . '[0][display]');
        $this->assertSession()
            ->checkboxNotChecked($field_name . '[0][display]');
    }
    
    /**
     * Tests description toggle for field instance configuration.
     */
    public function testDescToggle() : void {
        $type_name = 'test';
        $field_type = 'file';
        $field_name = $this->randomMachineName();
        // Use the UI to add a new content type that also contains a file field.
        $edit = [
            'name' => $type_name,
            'type' => $type_name,
        ];
        $this->drupalGet('admin/structure/types/add');
        $this->submitForm($edit, 'Save and manage fields');
        $field_edit = [
            'settings[description_field]' => TRUE,
        ];
        $this->fieldUIAddNewField('/admin/structure/types/manage/' . $type_name, $field_name, $this->randomString(), $field_type, [], $field_edit);
        // Add a node of our new type and upload a file to it.
        $file = current($this->drupalGetTestFiles('text'));
        $title = $this->randomString();
        $edit = [
            'title[0][value]' => $title,
            'files[field_' . $field_name . '_0]' => \Drupal::service('file_system')->realpath($file->uri),
        ];
        $this->drupalGet('node/add/' . $type_name);
        $this->submitForm($edit, 'Save');
        $node = $this->drupalGetNodeByTitle($title);
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->assertSession()
            ->pageTextContains('The description may be used as the label of the link to the file.');
    }
    
    /**
     * Tests description display of File Field.
     */
    public function testDescriptionDefaultFileFieldDisplay() : void {
        $field_name = $this->randomMachineName();
        $type_name = 'article';
        $field_storage_settings = [
            'display_field' => '1',
            'display_default' => '1',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ];
        $field_settings = [
            'description_field' => '1',
        ];
        $widget_settings = [];
        $this->createFileField($field_name, 'node', $type_name, $field_storage_settings, $field_settings, $widget_settings);
        $test_file = $this->getTestFile('text');
        // Create a new node with the uploaded file.
        $nid = $this->uploadNodeFile($test_file, $field_name, $type_name);
        // Add file description.
        $description = 'This is the test file description';
        $this->drupalGet("node/{$nid}/edit");
        $this->submitForm([
            $field_name . '[0][description]' => $description,
        ], 'Save');
        // Load uncached node.
        \Drupal::entityTypeManager()->getStorage('node')
            ->resetCache([
            $nid,
        ]);
        $node = Node::load($nid);
        // Test default formatter.
        $this->drupalGet('node/' . $nid);
        $this->assertSession()
            ->elementTextContains('xpath', '//a[@href="' . $node->{$field_name}->entity
            ->createFileUrl() . '"]', $description);
        // Change formatter to "Table of files".
        $display = \Drupal::entityTypeManager()->getStorage('entity_view_display')
            ->load('node.' . $type_name . '.default');
        $display->setComponent($field_name, [
            'label' => 'hidden',
            'type' => 'file_table',
        ])
            ->save();
        $this->drupalGet('node/' . $nid);
        $this->assertSession()
            ->elementTextContains('xpath', '//a[@href="' . $node->{$field_name}->entity
            ->createFileUrl() . '"]', $description);
        // Test that null file size is rendered as "Unknown".
        $nonexistent_file = File::create([
            'uri' => 'temporary://' . $this->randomMachineName() . '.txt',
        ]);
        $nonexistent_file->save();
        $node->set($field_name, $nonexistent_file->id());
        $node->save();
        $this->drupalGet('node/' . $nid);
        $this->assertSession()
            ->elementTextEquals('xpath', '//a[@href="' . $node->{$field_name}->entity
            ->createFileUrl() . '"]/../../../td[2]', 'Unknown');
    }

}

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::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::$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::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::__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.
FileFieldDisplayTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FileFieldDisplayTest::testDefaultFileFieldDisplay public function Tests default display of File Field.
FileFieldDisplayTest::testDescriptionDefaultFileFieldDisplay public function Tests description display of File Field.
FileFieldDisplayTest::testDescToggle public function Tests description toggle for field instance configuration.
FileFieldDisplayTest::testNodeDisplay public function Tests normal formatter display on node display.
FileFieldTestBase::$adminUser protected property A user with administration permissions.
FileFieldTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 7
FileFieldTestBase::assertFileEntryExists public function Asserts that a file exists in the database.
FileFieldTestBase::assertFileEntryNotExists public function Asserts that a file does not exist in the database.
FileFieldTestBase::assertFileIsPermanent public function Asserts that a file's status is set to permanent in the database.
FileFieldTestBase::getLastFileId public function Retrieves the fid of the last inserted file.
FileFieldTestBase::getTestFile public function Retrieves a sample file of the specified type.
FileFieldTestBase::removeNodeFile public function Removes a file from a node.
FileFieldTestBase::replaceNodeFile public function Replaces a file within a node.
FileFieldTestBase::setUp protected function Overrides BrowserTestBase::setUp 6
FileFieldTestBase::updateFileField public function Updates an existing file field with new settings.
FileFieldTestBase::uploadNodeFile public function Uploads a file to a node.
FileFieldTestBase::uploadNodeFiles public function Uploads multiple files to a node.
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::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. 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. Aliased as: drupalGetTestFiles
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::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.