class TranslationTest

Same name in this branch
  1. 11.x core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php \Drupal\Tests\Core\Annotation\TranslationTest
Same name in other branches
  1. 9 core/modules/field/tests/src/Kernel/TranslationTest.php \Drupal\Tests\field\Kernel\TranslationTest
  2. 9 core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php \Drupal\Tests\Core\Annotation\TranslationTest
  3. 8.9.x core/modules/field/tests/src/Kernel/TranslationTest.php \Drupal\Tests\field\Kernel\TranslationTest
  4. 8.9.x core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php \Drupal\Tests\Core\Annotation\TranslationTest
  5. 10 core/modules/field/tests/src/Kernel/TranslationTest.php \Drupal\Tests\field\Kernel\TranslationTest
  6. 10 core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php \Drupal\Tests\Core\Annotation\TranslationTest

Tests multilingual fields logic.

The following tests will check the multilingual logic in field handling.

@group field

Hierarchy

Expanded class hierarchy of TranslationTest

File

core/modules/field/tests/src/Kernel/TranslationTest.php, line 18

Namespace

Drupal\Tests\field\Kernel
View source
class TranslationTest extends FieldKernelTestBase {
    
    /**
     * Modules to install.
     *
     * The node module is required because the tests alter the node entity type.
     *
     * @var array
     */
    protected static $modules = [
        'language',
        'node',
    ];
    
    /**
     * The name of the field to use in this test.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * The name of the entity type to use in this test.
     *
     * @var string
     */
    protected $entityType = 'test_entity';
    
    /**
     * An array defining the field storage to use in this test.
     *
     * @var array
     */
    protected $fieldStorageDefinition;
    
    /**
     * An array defining the field to use in this test.
     *
     * @var array
     */
    protected $fieldDefinition;
    
    /**
     * The field storage to use in this test.
     *
     * @var \Drupal\field\Entity\FieldStorageConfig
     */
    protected $fieldStorage;
    
    /**
     * The field to use in this test.
     *
     * @var \Drupal\field\Entity\FieldConfig
     */
    protected $field;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('node');
        $this->installConfig([
            'language',
        ]);
        $this->fieldName = $this->randomMachineName();
        $this->entityType = 'entity_test';
        $this->fieldStorageDefinition = [
            'field_name' => $this->fieldName,
            'entity_type' => $this->entityType,
            'type' => 'test_field',
            'cardinality' => 4,
        ];
        $this->fieldStorage = FieldStorageConfig::create($this->fieldStorageDefinition);
        $this->fieldStorage
            ->save();
        $this->fieldDefinition = [
            'field_storage' => $this->fieldStorage,
            'bundle' => 'entity_test',
        ];
        $this->field = FieldConfig::create($this->fieldDefinition);
        $this->field
            ->save();
        for ($i = 0; $i < 3; ++$i) {
            ConfigurableLanguage::create([
                'id' => 'l' . $i,
                'label' => $this->randomString(),
            ])
                ->save();
        }
    }
    
    /**
     * Tests translatable fields storage/retrieval.
     */
    public function testTranslatableFieldSaveLoad() : void {
        // Enable field translations for nodes.
        field_test_entity_info_translatable('node', TRUE);
        $entity_type = \Drupal::entityTypeManager()->getDefinition('node');
        $this->assertTrue($entity_type->isTranslatable(), 'Nodes are translatable.');
        // Prepare the field translations.
        $entity_type_id = 'entity_test';
        field_test_entity_info_translatable($entity_type_id, TRUE);
        $entity = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity_type_id)
            ->create([
            'type' => $this->field
                ->getTargetBundle(),
        ]);
        $field_translations = [];
        $available_langcodes = array_keys($this->container
            ->get('language_manager')
            ->getLanguages());
        $entity->langcode->value = reset($available_langcodes);
        foreach ($available_langcodes as $langcode) {
            $field_translations[$langcode] = $this->_generateTestFieldValues($this->fieldStorage
                ->getCardinality());
            $translation = $entity->hasTranslation($langcode) ? $entity->getTranslation($langcode) : $entity->addTranslation($langcode);
            $translation->{$this->fieldName}
                ->setValue($field_translations[$langcode]);
        }
        // Save and reload the field translations.
        $entity = $this->entitySaveReload($entity);
        // Check if the correct values were saved/loaded.
        foreach ($field_translations as $langcode => $items) {
            $result = TRUE;
            foreach ($items as $delta => $item) {
                $result = $result && $item['value'] == $entity->getTranslation($langcode)->{$this->fieldName}[$delta]->value;
            }
            $this->assertTrue($result, "{$langcode} translation correctly handled.");
        }
        // Test default values.
        $field_name_default = $this->randomMachineName() . '_field_name';
        $field_storage_definition = $this->fieldStorageDefinition;
        $field_storage_definition['field_name'] = $field_name_default;
        $field_storage = FieldStorageConfig::create($field_storage_definition);
        $field_storage->save();
        $field_definition = $this->fieldDefinition;
        $field_definition['field_storage'] = $field_storage;
        $field_definition['default_value'] = [
            [
                'value' => rand(1, 127),
            ],
        ];
        $field = FieldConfig::create($field_definition);
        $field->save();
        $translation_langcodes = array_slice($available_langcodes, 0, 2);
        asort($translation_langcodes);
        $translation_langcodes = array_values($translation_langcodes);
        $values = [
            'type' => $field->getTargetBundle(),
            'langcode' => $translation_langcodes[0],
        ];
        $entity = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity_type_id)
            ->create($values);
        foreach ($translation_langcodes as $langcode) {
            $values[$this->fieldName][$langcode] = $this->_generateTestFieldValues($this->fieldStorage
                ->getCardinality());
            $translation = $entity->hasTranslation($langcode) ? $entity->getTranslation($langcode) : $entity->addTranslation($langcode);
            $translation->{$this->fieldName}
                ->setValue($values[$this->fieldName][$langcode]);
        }
        $field_langcodes = array_keys($entity->getTranslationLanguages());
        sort($field_langcodes);
        $this->assertEquals($translation_langcodes, $field_langcodes, 'Missing translations did not get a default value.');
        // @todo Test every translation once the Entity Translation API allows for
        //   multilingual defaults.
        $langcode = $entity->language()
            ->getId();
        $this->assertEquals($field->getDefaultValueLiteral(), $entity->getTranslation($langcode)->{$field_name_default}
            ->getValue(), "Default value correctly populated for language {$langcode}.");
        $storage = \Drupal::entityTypeManager()->getStorage($entity_type_id);
        // Check that explicit empty values are not overridden with default values.
        foreach ([
            NULL,
            [],
        ] as $empty_items) {
            $values = [
                'type' => $field->getTargetBundle(),
                'langcode' => $translation_langcodes[0],
            ];
            $entity = $storage->create($values);
            foreach ($translation_langcodes as $langcode) {
                $values[$this->fieldName][$langcode] = $this->_generateTestFieldValues($this->fieldStorage
                    ->getCardinality());
                $translation = $entity->hasTranslation($langcode) ? $entity->getTranslation($langcode) : $entity->addTranslation($langcode);
                $translation->{$this->fieldName}
                    ->setValue($values[$this->fieldName][$langcode]);
                $translation->{$field_name_default}
                    ->setValue($empty_items);
                $values[$field_name_default][$langcode] = $empty_items;
            }
            foreach ($entity->getTranslationLanguages() as $langcode => $language) {
                $this->assertEquals([], $entity->getTranslation($langcode)->{$field_name_default}
                    ->getValue(), "Empty value correctly populated for language {$langcode}.");
            }
        }
    }
    
    /**
     * Tests field access.
     *
     * Regression test to verify that fieldAccess() can be called while only
     * passing the required parameters.
     *
     * @see https://www.drupal.org/node/2404739
     */
    public function testFieldAccess() : void {
        $access_control_handler = \Drupal::entityTypeManager()->getAccessControlHandler($this->entityType);
        $this->assertTrue($access_control_handler->fieldAccess('view', $this->field));
    }

}

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.
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.
TranslationTest::$entityType protected property The name of the entity type to use in this test.
TranslationTest::$field protected property The field to use in this test.
TranslationTest::$fieldDefinition protected property An array defining the field to use in this test.
TranslationTest::$fieldName protected property The name of the field to use in this test.
TranslationTest::$fieldStorage protected property The field storage to use in this test.
TranslationTest::$fieldStorageDefinition protected property An array defining the field storage to use in this test.
TranslationTest::$modules protected static property Modules to install. Overrides FieldKernelTestBase::$modules
TranslationTest::setUp protected function Set the default field storage backend for fields created during tests. Overrides FieldKernelTestBase::setUp
TranslationTest::testFieldAccess public function Tests field access.
TranslationTest::testTranslatableFieldSaveLoad public function Tests translatable fields storage/retrieval.

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