class FileItemTest

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

Tests using entity fields of the file field type.

@group file

Hierarchy

Expanded class hierarchy of FileItemTest

1 file declares its use of FileItemTest
WorkspacesFileItemTest.php in core/modules/workspaces/tests/src/Kernel/WorkspacesFileItemTest.php

File

core/modules/file/tests/src/Kernel/FileItemTest.php, line 22

Namespace

Drupal\Tests\file\Kernel
View source
class FileItemTest extends FieldKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'file',
    ];
    
    /**
     * Created file entity.
     *
     * @var \Drupal\file\Entity\File
     */
    protected $file;
    
    /**
     * Directory where the sample files are stored.
     *
     * @var string
     */
    protected $directory;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
        $this->installConfig([
            'user',
        ]);
        // Give anonymous users permission to access content, so they can view and
        // download public files.
        $anonymous_role = Role::load(Role::ANONYMOUS_ID);
        $anonymous_role->grantPermission('access content');
        $anonymous_role->save();
        $this->installEntitySchema('file');
        $this->installSchema('file', [
            'file_usage',
        ]);
        FieldStorageConfig::create([
            'field_name' => 'file_test',
            'entity_type' => 'entity_test',
            'type' => 'file',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ])->save();
        $this->directory = $this->getRandomGenerator()
            ->name(8);
        FieldConfig::create([
            'entity_type' => 'entity_test',
            'field_name' => 'file_test',
            'bundle' => 'entity_test',
            'settings' => [
                'file_directory' => $this->directory,
            ],
        ])
            ->save();
        file_put_contents('public://example.txt', $this->randomMachineName());
        $this->file = File::create([
            'uri' => 'public://example.txt',
        ]);
        $this->file
            ->save();
    }
    
    /**
     * Tests using entity fields of the file field type.
     */
    public function testFileItem() : void {
        // Check that the selection handler was automatically assigned to
        // 'default:file'.
        $field_definition = FieldConfig::load('entity_test.entity_test.file_test');
        $handler_id = $field_definition->getSetting('handler');
        $this->assertEquals('default:file', $handler_id);
        // Create a test entity with the
        $entity = EntityTest::create();
        $entity->file_test->target_id = $this->file
            ->id();
        $entity->file_test->display = 1;
        $entity->file_test->description = $description = $this->randomMachineName();
        $entity->name->value = $this->randomMachineName();
        $entity->save();
        $entity = EntityTest::load($entity->id());
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->file_test);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->file_test[0]);
        $this->assertEquals($this->file
            ->id(), $entity->file_test->target_id);
        $this->assertEquals(1, $entity->file_test->display);
        $this->assertEquals($description, $entity->file_test->description);
        $this->assertEquals($this->file
            ->getFileUri(), $entity->file_test->entity
            ->getFileUri());
        $this->assertEquals($this->file
            ->id(), $entity->file_test->entity
            ->id());
        $this->assertEquals($this->file
            ->uuid(), $entity->file_test->entity
            ->uuid());
        // Make sure the computed files reflects updates to the file.
        file_put_contents('public://example-2.txt', $this->randomMachineName());
        $file2 = File::create([
            'uri' => 'public://example-2.txt',
        ]);
        $file2->save();
        $entity->file_test->target_id = $file2->id();
        $this->assertEquals($entity->file_test->entity
            ->id(), $file2->id());
        $this->assertEquals($entity->file_test->entity
            ->getFileUri(), $file2->getFileUri());
        // Test the deletion of an entity having an entity reference field targeting
        // a non-existing entity.
        $file2->delete();
        $entity->delete();
        // Test the generateSampleValue() method.
        $entity = EntityTest::create();
        $entity->file_test
            ->generateSampleItems();
        $this->entityValidateAndSave($entity);
        // Verify that the sample file was stored in the correct directory.
        $uri = $entity->file_test->entity
            ->getFileUri();
        
        /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
        $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
        $this->assertEquals($this->directory, dirname($stream_wrapper_manager::getTarget($uri)));
        // Make sure the computed files reflects updates to the file.
        file_put_contents('public://example-3.txt', $this->randomMachineName());
        // Test unsaved file entity.
        $file3 = File::create([
            'uri' => 'public://example-3.txt',
        ]);
        $display = \Drupal::service('entity_display.repository')->getViewDisplay('entity_test', 'entity_test');
        $display->setComponent('file_test', [
            'label' => 'above',
            'type' => 'file_default',
            'weight' => 1,
        ])
            ->save();
        $entity = EntityTest::create();
        $entity->file_test = [
            'entity' => $file3,
        ];
        $uri = $file3->getFileUri();
        $output = \Drupal::entityTypeManager()->getViewBuilder('entity_test')
            ->view($entity, 'default');
        \Drupal::service('renderer')->renderRoot($output);
        $this->assertTrue(!empty($entity->file_test->entity));
        $this->assertEquals($uri, $entity->file_test->entity
            ->getFileUri());
    }

}

Members

Title Sort descending Deprecated 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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::assertFieldValues protected function Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage protected function Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload protected function Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave protected function Validate and save entity. Fail if violations are found.
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
FileItemTest::$directory protected property Directory where the sample files are stored.
FileItemTest::$file protected property Created file entity.
FileItemTest::$modules protected static property Modules to install. Overrides FieldKernelTestBase::$modules 1
FileItemTest::setUp protected function Set the default field storage backend for fields created during tests. Overrides FieldKernelTestBase::setUp 1
FileItemTest::testFileItem public function Tests using entity fields of the file field type. 1
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. 4
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. 2
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. 2
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 install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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 28
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
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
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.