Newer
Older
<?php
/**
* @file
* Contains \Drupal\field\Tests\TranslationTest.
*/
namespace Drupal\field\Tests;
use Drupal\Component\Utility\Unicode;
use Drupal\field\Entity\FieldConfig;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\field\Entity\FieldStorageConfig;
/**
* Tests multilanguage fields logic.
* The following tests will check the multilanguage logic in field handling.
*
* @group field
Angie Byron
committed
class TranslationTest extends FieldUnitTestBase {
/**
* Modules to enable.
*
Alex Pott
committed
* node is required because the tests alter the node entity type.
Angie Byron
committed
*
* @var array
*/
Angie Byron
committed
public static $modules = array('language', 'node');
Dries Buytaert
committed
/**
* The name of the field to use in this test.
*
* @var string
*/
Alex Pott
committed
protected $fieldName;
Dries Buytaert
committed
/**
* The name of the entity type to use in this test.
*
* @var string
*/
Alex Pott
committed
protected $entityType = 'test_entity';
Dries Buytaert
committed
/**
* An array defining the field storage to use in this test.
Dries Buytaert
committed
*
* @var array
*/
Alex Pott
committed
protected $fieldStorageDefinition;
Dries Buytaert
committed
/**
* An array defining the field to use in this test.
Dries Buytaert
committed
*
* @var array
*/
Alex Pott
committed
protected $fieldDefinition;
Dries Buytaert
committed
/**
* The field storage to use in this test.
Dries Buytaert
committed
*
* @var \Drupal\field\Entity\FieldStorageConfig
Dries Buytaert
committed
*/
protected $fieldStorage;
Dries Buytaert
committed
/**
* The field to use in this test.
Dries Buytaert
committed
*
* @var \Drupal\field\Entity\FieldConfig
Dries Buytaert
committed
*/
protected $field;
Dries Buytaert
committed
/**
* {@inheritdoc}
*/
Alex Pott
committed
protected function setUp() {
parent::setUp();
$this->installConfig(array('language'));
Alex Pott
committed
$this->fieldName = Unicode::strtolower($this->randomMachineName());
Alex Pott
committed
$this->entityType = 'entity_test';
Alex Pott
committed
$this->fieldStorageDefinition = array(
'field_name' => $this->fieldName,
'entity_type' => $this->entityType,
'type' => 'test_field',
'cardinality' => 4,
);
$this->fieldStorage = FieldStorageConfig::create($this->fieldStorageDefinition);
$this->fieldStorage->save();
Alex Pott
committed
$this->fieldDefinition = array(
'field_storage' => $this->fieldStorage,
'bundle' => 'entity_test',
$this->field = FieldConfig::create($this->fieldDefinition);
$this->field->save();
for ($i = 0; $i < 3; ++$i) {
ConfigurableLanguage::create(array(
'id' => 'l' . $i,
'label' => $this->randomString(),
))->save();
}
}
/**
* Test translatable fields storage/retrieval.
*/
function testTranslatableFieldSaveLoad() {
// Enable field translations for nodes.
field_test_entity_info_translatable('node', TRUE);
Alex Pott
committed
$entity_type = \Drupal::entityManager()->getDefinition('node');
$this->assertTrue($entity_type->isTranslatable(), 'Nodes are translatable.');
// Prepare the field translations.
Alex Pott
committed
$entity_type_id = 'entity_test';
field_test_entity_info_translatable($entity_type_id, TRUE);
$entity = entity_create($entity_type_id, array('type' => $this->field->getTargetBundle()));
$field_translations = array();
$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) {
Alex Pott
committed
$result = $result && $item['value'] == $entity->getTranslation($langcode)->{$this->fieldName}[$delta]->value;
Jennifer Hodgdon
committed
$this->assertTrue($result, format_string('%language translation correctly handled.', array('%language' => $langcode)));
Angie Byron
committed
// Test default values.
$field_name_default = Unicode::strtolower($this->randomMachineName() . '_field_name');
Alex Pott
committed
$field_storage_definition = $this->fieldStorageDefinition;
Alex Pott
committed
$field_storage_definition['field_name'] = $field_name_default;
$field_storage = FieldStorageConfig::create($field_storage_definition);
$field_storage->save();
Alex Pott
committed
Alex Pott
committed
$field_definition = $this->fieldDefinition;
$field_definition['field_storage'] = $field_storage;
$field_definition['default_value'] = array(array('value' => rand(1, 127)));
$field = FieldConfig::create($field_definition);
$field->save();
Alex Pott
committed
Angie Byron
committed
$translation_langcodes = array_slice($available_langcodes, 0, 2);
asort($translation_langcodes);
$translation_langcodes = array_values($translation_langcodes);
$values = array('type' => $field->getTargetBundle(), 'langcode' => $translation_langcodes[0]);
Alex Pott
committed
$entity = entity_create($entity_type_id, $values);
Angie Byron
committed
foreach ($translation_langcodes as $langcode) {
Alex Pott
committed
$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]);
Angie Byron
committed
}
$field_langcodes = array_keys($entity->getTranslationLanguages());
sort($field_langcodes);
Angie Byron
committed
$this->assertEqual($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->assertEqual($entity->getTranslation($langcode)->{$field_name_default}->getValue(), $field->getDefaultValueLiteral(), format_string('Default value correctly populated for language %language.', array('%language' => $langcode)));
Angie Byron
committed
// Check that explicit empty values are not overridden with default values.
foreach (array(NULL, array()) as $empty_items) {
$values = array('type' => $field->getTargetBundle(), 'langcode' => $translation_langcodes[0]);
Alex Pott
committed
$entity = entity_create($entity_type_id, $values);
Angie Byron
committed
foreach ($translation_langcodes as $langcode) {
Alex Pott
committed
$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);
Angie Byron
committed
$values[$field_name_default][$langcode] = $empty_items;
}
foreach ($entity->getTranslationLanguages() as $langcode => $language) {
$this->assertEqual($entity->getTranslation($langcode)->{$field_name_default}->getValue(), $empty_items, format_string('Empty value correctly populated for language %language.', array('%language' => $langcode)));
Angie Byron
committed
}
}
}
/**
* 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() {
Alex Pott
committed
$access_control_handler = \Drupal::entityManager()->getAccessControlHandler($this->entityType);
$this->assertTrue($access_control_handler->fieldAccess('view', $this->field));
}