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