class FileEntityFormatterTest

Same name and namespace in other branches
  1. 9 core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php \Drupal\Tests\file\Kernel\Formatter\FileEntityFormatterTest
  2. 8.9.x core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php \Drupal\Tests\file\Kernel\Formatter\FileEntityFormatterTest
  3. 10 core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php \Drupal\Tests\file\Kernel\Formatter\FileEntityFormatterTest

Tests the default file formatter.

@group field

Hierarchy

Expanded class hierarchy of FileEntityFormatterTest

File

core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php, line 16

Namespace

Drupal\Tests\file\Kernel\Formatter
View source
class FileEntityFormatterTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'file',
        'user',
        'file_test',
    ];
    
    /**
     * The files.
     *
     * @var array
     */
    protected $files;
    
    /**
     * The file URL generator.
     *
     * @var \Drupal\Core\File\FileUrlGeneratorInterface
     */
    protected $fileUrlGenerator;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->fileUrlGenerator = $this->container
            ->get('file_url_generator');
        $this->installEntitySchema('file');
        $this->files = [];
        file_put_contents('public://file.png', str_repeat('t', 10));
        $file = File::create([
            'uri' => 'public://file.png',
            'filename' => 'file.png',
        ]);
        $file->save();
        $this->files[] = $file;
        file_put_contents('public://file.tar', str_repeat('t', 200));
        $file = File::create([
            'uri' => 'public://file.tar',
            'filename' => 'file.tar',
        ]);
        $file->save();
        $this->files[] = $file;
        file_put_contents('public://file.tar.gz', str_repeat('t', 40000));
        $file = File::create([
            'uri' => 'public://file.tar.gz',
            'filename' => 'file.tar.gz',
        ]);
        $file->save();
        $this->files[] = $file;
        file_put_contents('public://file', str_repeat('t', 8000000));
        $file = File::create([
            'uri' => 'public://file',
            'filename' => 'file',
        ]);
        $file->save();
        $this->files[] = $file;
    }
    
    /**
     * Tests the file_link field formatter.
     */
    public function testFormatterFileLink() : void {
        $entity_display = EntityViewDisplay::create([
            'targetEntityType' => 'file',
            'bundle' => 'file',
        ]);
        $entity_display->setComponent('filename', [
            'type' => 'file_link',
        ]);
        $build = $entity_display->buildMultiple($this->files)[0]['filename'][0];
        $this->assertEquals('file.png', $build['#title']);
        $this->assertEquals($this->fileUrlGenerator
            ->generate('public://file.png'), $build['#url']);
    }
    
    /**
     * Tests the file_link field formatter.
     */
    public function testFormatterFileUri() : void {
        $entity_display = EntityViewDisplay::create([
            'targetEntityType' => 'file',
            'bundle' => 'file',
        ]);
        $entity_display->setComponent('uri', [
            'type' => 'file_uri',
        ]);
        $build = $entity_display->buildMultiple($this->files)[0]['uri'][0];
        $this->assertEquals('public://file.png', $build['#markup']);
        $entity_display->setComponent('uri', [
            'type' => 'file_uri',
            'settings' => [
                'file_download_path' => TRUE,
            ],
        ]);
        $build = $entity_display->buildMultiple($this->files)[0]['uri'][0];
        $this->assertEquals($this->fileUrlGenerator
            ->generateString('public://file.png'), $build['#markup']);
        $entity_display->setComponent('uri', [
            'type' => 'file_uri',
            'settings' => [
                'file_download_path' => TRUE,
                'link_to_file' => TRUE,
            ],
        ]);
        $build = $entity_display->buildMultiple($this->files)[0]['uri'][0];
        $this->assertEquals($this->fileUrlGenerator
            ->generateString('public://file.png'), $build['#title']);
        $this->assertEquals($this->fileUrlGenerator
            ->generate('public://file.png'), $build['#url']);
    }
    
    /**
     * Tests the file_extension field formatter.
     */
    public function testFormatterFileExtension() : void {
        $entity_display = EntityViewDisplay::create([
            'targetEntityType' => 'file',
            'bundle' => 'file',
        ]);
        $entity_display->setComponent('filename', [
            'type' => 'file_extension',
        ]);
        $expected = [
            'png',
            'tar',
            'gz',
            '',
        ];
        foreach (array_values($this->files) as $i => $file) {
            $build = $entity_display->build($file);
            $this->assertEquals($expected[$i], $build['filename'][0]['#markup']);
        }
        $entity_display->setComponent('filename', [
            'type' => 'file_extension',
            'settings' => [
                'extension_detect_tar' => TRUE,
            ],
        ]);
        $expected = [
            'png',
            'tar',
            'tar.gz',
            '',
        ];
        foreach (array_values($this->files) as $i => $file) {
            $build = $entity_display->build($file);
            $this->assertEquals($expected[$i], $build['filename'][0]['#markup']);
        }
    }
    
    /**
     * Tests the file_extension field formatter.
     */
    public function testFormatterFileMime() : void {
        $entity_display = EntityViewDisplay::create([
            'targetEntityType' => 'file',
            'bundle' => 'file',
        ]);
        $entity_display->setComponent('filemime', [
            'type' => 'file_filemime',
            'settings' => [
                'filemime_image' => TRUE,
            ],
        ]);
        foreach (array_values($this->files) as $i => $file) {
            $build = $entity_display->build($file);
            $this->assertEquals('image__file_icon', $build['filemime'][0]['#theme']);
            $this->assertEquals(spl_object_hash($file), spl_object_hash($build['filemime'][0]['#file']));
        }
    }
    
    /**
     * Tests the file_size field formatter.
     */
    public function testFormatterFileSize() : void {
        $entity_display = EntityViewDisplay::create([
            'targetEntityType' => 'file',
            'bundle' => 'file',
        ]);
        $entity_display->setComponent('filesize', [
            'type' => 'file_size',
        ]);
        $expected = [
            '10 bytes',
            '200 bytes',
            '39.06 KB',
            '7.63 MB',
        ];
        foreach (array_values($this->files) as $i => $file) {
            $build = $entity_display->build($file);
            $this->assertEquals($expected[$i], $build['filesize'][0]['#markup']);
        }
    }
    
    /**
     * Tests the file_link field formatter using a query string.
     */
    public function testFormatterFileLinkWithQueryString() : void {
        $file = File::create([
            'uri' => 'dummy-external-readonly://file-query-string?foo=bar',
            'filename' => 'file-query-string',
        ]);
        $file->save();
        $file_link = [
            '#theme' => 'file_link',
            '#file' => $file,
        ];
        $output = (string) \Drupal::service('renderer')->renderRoot($file_link);
        $this->assertStringContainsString($this->fileUrlGenerator
            ->generate('dummy-external-readonly://file-query-string?foo=bar')
            ->toUriString(), $output);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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.
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.
FileEntityFormatterTest::$files protected property The files.
FileEntityFormatterTest::$fileUrlGenerator protected property The file URL generator.
FileEntityFormatterTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
FileEntityFormatterTest::setUp protected function Overrides KernelTestBase::setUp
FileEntityFormatterTest::testFormatterFileExtension public function Tests the file_extension field formatter.
FileEntityFormatterTest::testFormatterFileLink public function Tests the file_link field formatter.
FileEntityFormatterTest::testFormatterFileLinkWithQueryString public function Tests the file_link field formatter using a query string.
FileEntityFormatterTest::testFormatterFileMime public function Tests the file_extension field formatter.
FileEntityFormatterTest::testFormatterFileSize public function Tests the file_size field formatter.
FileEntityFormatterTest::testFormatterFileUri public function Tests the file_link field formatter.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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