EntityReferenceItemTest.php in Zircon Profile 8

Contains \Drupal\field\Tests\EntityReference\EntityReferenceItemTest.

Namespace

Drupal\field\Tests\EntityReference

File

core/modules/field/src/Tests/EntityReference/EntityReferenceItemTest.php

<?php

/**
 * @file
 * Contains \Drupal\field\Tests\EntityReference\EntityReferenceItemTest.
 */
namespace Drupal\field\Tests\EntityReference;

use Drupal\comment\Entity\Comment;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FieldItemInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Language\LanguageInterface;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\entity_test\Entity\EntityTestStringId;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\field\Tests\FieldUnitTestBase;
use Drupal\file\Entity\File;
use Drupal\node\Entity\Node;
use Drupal\taxonomy\Entity\Term;
use Drupal\taxonomy\Entity\Vocabulary;
use Drupal\user\Entity\User;

/**
 * Tests the new entity API for the entity reference field type.
 *
 * @group entity_reference
 */
class EntityReferenceItemTest extends FieldUnitTestBase {
  use EntityReferenceTestTrait;

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = [
    'node',
    'comment',
    'file',
    'taxonomy',
    'text',
    'filter',
    'views',
    'field',
  ];

  /**
   * The taxonomy vocabulary to test with.
   *
   * @var \Drupal\taxonomy\VocabularyInterface
   */
  protected $vocabulary;

  /**
   * The taxonomy term to test with.
   *
   * @var \Drupal\taxonomy\TermInterface
   */
  protected $term;

  /**
   * The test entity with a string ID.
   *
   * @var \Drupal\entity_test\Entity\EntityTestStringId
   */
  protected $entityStringId;

  /**
   * Sets up the test.
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test_string_id');
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('comment');
    $this
      ->installEntitySchema('file');
    $this
      ->installSchema('comment', [
      'comment_entity_statistics',
    ]);
    $this->vocabulary = entity_create('taxonomy_vocabulary', array(
      'name' => $this
        ->randomMachineName(),
      'vid' => Unicode::strtolower($this
        ->randomMachineName()),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $this->vocabulary
      ->save();
    $this->term = entity_create('taxonomy_term', array(
      'name' => $this
        ->randomMachineName(),
      'vid' => $this->vocabulary
        ->id(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $this->term
      ->save();
    $this->entityStringId = EntityTestStringId::create([
      'id' => $this
        ->randomMachineName(),
    ]);
    $this->entityStringId
      ->save();

    // Use the util to create an instance.
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_taxonomy_term', 'Test content entity reference', 'taxonomy_term');
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_entity_test_string_id', 'Test content entity reference with string ID', 'entity_test_string_id');
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_taxonomy_vocabulary', 'Test config entity reference', 'taxonomy_vocabulary');
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_node', 'Test node entity reference', 'node');
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_user', 'Test user entity reference', 'user');
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_comment', 'Test comment entity reference', 'comment');
    $this
      ->createEntityReferenceField('entity_test', 'entity_test', 'field_test_file', 'Test file entity reference', 'file');
  }

  /**
   * Tests the entity reference field type for referencing content entities.
   */
  public function testContentEntityReferenceItem() {
    $tid = $this->term
      ->id();

    // Just being able to create the entity like this verifies a lot of code.
    $entity = entity_create('entity_test');
    $entity->field_test_taxonomy_term->target_id = $tid;
    $entity->name->value = $this
      ->randomMachineName();
    $entity
      ->save();
    $entity = entity_load('entity_test', $entity
      ->id());
    $this
      ->assertTrue($entity->field_test_taxonomy_term instanceof FieldItemListInterface, 'Field implements interface.');
    $this
      ->assertTrue($entity->field_test_taxonomy_term[0] instanceof FieldItemInterface, 'Field item implements interface.');
    $this
      ->assertEqual($entity->field_test_taxonomy_term->target_id, $tid);
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->getName(), $this->term
      ->getName());
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->id(), $tid);
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->uuid(), $this->term
      ->uuid());

    // Verify that the label for the target ID property definition is correct.
    $label = $entity->field_test_taxonomy_term
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getPropertyDefinition('target_id')
      ->getLabel();
    $this
      ->assertTrue($label instanceof TranslatableMarkup);
    $this
      ->assertEqual($label
      ->render(), 'Taxonomy term ID');

    // Change the name of the term via the reference.
    $new_name = $this
      ->randomMachineName();
    $entity->field_test_taxonomy_term->entity
      ->setName($new_name);
    $entity->field_test_taxonomy_term->entity
      ->save();

    // Verify it is the correct name.
    $term = Term::load($tid);
    $this
      ->assertEqual($term
      ->getName(), $new_name);

    // Make sure the computed term reflects updates to the term id.
    $term2 = entity_create('taxonomy_term', array(
      'name' => $this
        ->randomMachineName(),
      'vid' => $this->term
        ->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $term2
      ->save();

    // Test all the possible ways of assigning a value.
    $entity->field_test_taxonomy_term->target_id = $term
      ->id();
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->id(), $term
      ->id());
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->getName(), $term
      ->getName());
    $entity->field_test_taxonomy_term = [
      [
        'target_id' => $term2
          ->id(),
      ],
    ];
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->id(), $term2
      ->id());
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->getName(), $term2
      ->getName());

    // Test value assignment via the computed 'entity' property.
    $entity->field_test_taxonomy_term->entity = $term;
    $this
      ->assertEqual($entity->field_test_taxonomy_term->target_id, $term
      ->id());
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->getName(), $term
      ->getName());
    $entity->field_test_taxonomy_term = [
      [
        'entity' => $term2,
      ],
    ];
    $this
      ->assertEqual($entity->field_test_taxonomy_term->target_id, $term2
      ->id());
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->getName(), $term2
      ->getName());

    // Test assigning an invalid item throws an exception.
    try {
      $entity->field_test_taxonomy_term = [
        'target_id' => 'invalid',
        'entity' => $term2,
      ];
      $this
        ->fail('Assigning an invalid item throws an exception.');
    } catch (\InvalidArgumentException $e) {
      $this
        ->pass('Assigning an invalid item throws an exception.');
    }

    // Delete terms so we have nothing to reference and try again
    $term
      ->delete();
    $term2
      ->delete();
    $entity = entity_create('entity_test', array(
      'name' => $this
        ->randomMachineName(),
    ));
    $entity
      ->save();

    // Test the generateSampleValue() method.
    $entity = entity_create('entity_test');
    $entity->field_test_taxonomy_term
      ->generateSampleItems();
    $entity->field_test_taxonomy_vocabulary
      ->generateSampleItems();
    $this
      ->entityValidateAndSave($entity);
  }

  /**
   * Tests referencing content entities with string IDs.
   */
  public function testContentEntityReferenceItemWithStringId() {
    $entity = EntityTest::create();
    $entity->field_test_entity_test_string_id->target_id = $this->entityStringId
      ->id();
    $entity
      ->save();
    $storage = \Drupal::entityManager()
      ->getStorage('entity_test');
    $storage
      ->resetCache();
    $this
      ->assertEqual($this->entityStringId
      ->id(), $storage
      ->load($entity
      ->id())->field_test_entity_test_string_id->target_id);

    // Verify that the label for the target ID property definition is correct.
    $label = $entity->field_test_taxonomy_term
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getPropertyDefinition('target_id')
      ->getLabel();
    $this
      ->assertTrue($label instanceof TranslatableMarkup);
    $this
      ->assertEqual($label
      ->render(), 'Taxonomy term ID');
  }

  /**
   * Tests the entity reference field type for referencing config entities.
   */
  public function testConfigEntityReferenceItem() {
    $referenced_entity_id = $this->vocabulary
      ->id();

    // Just being able to create the entity like this verifies a lot of code.
    $entity = entity_create('entity_test');
    $entity->field_test_taxonomy_vocabulary->target_id = $referenced_entity_id;
    $entity->name->value = $this
      ->randomMachineName();
    $entity
      ->save();
    $entity = entity_load('entity_test', $entity
      ->id());
    $this
      ->assertTrue($entity->field_test_taxonomy_vocabulary instanceof FieldItemListInterface, 'Field implements interface.');
    $this
      ->assertTrue($entity->field_test_taxonomy_vocabulary[0] instanceof FieldItemInterface, 'Field item implements interface.');
    $this
      ->assertEqual($entity->field_test_taxonomy_vocabulary->target_id, $referenced_entity_id);
    $this
      ->assertEqual($entity->field_test_taxonomy_vocabulary->entity
      ->label(), $this->vocabulary
      ->label());
    $this
      ->assertEqual($entity->field_test_taxonomy_vocabulary->entity
      ->id(), $referenced_entity_id);
    $this
      ->assertEqual($entity->field_test_taxonomy_vocabulary->entity
      ->uuid(), $this->vocabulary
      ->uuid());

    // Change the name of the term via the reference.
    $new_name = $this
      ->randomMachineName();
    $entity->field_test_taxonomy_vocabulary->entity
      ->set('name', $new_name);
    $entity->field_test_taxonomy_vocabulary->entity
      ->save();

    // Verify it is the correct name.
    $vocabulary = Vocabulary::load($referenced_entity_id);
    $this
      ->assertEqual($vocabulary
      ->label(), $new_name);

    // Make sure the computed term reflects updates to the term id.
    $vocabulary2 = entity_create('taxonomy_vocabulary', array(
      'name' => $this
        ->randomMachineName(),
      'vid' => Unicode::strtolower($this
        ->randomMachineName()),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $vocabulary2
      ->save();
    $entity->field_test_taxonomy_vocabulary->target_id = $vocabulary2
      ->id();
    $this
      ->assertEqual($entity->field_test_taxonomy_vocabulary->entity
      ->id(), $vocabulary2
      ->id());
    $this
      ->assertEqual($entity->field_test_taxonomy_vocabulary->entity
      ->label(), $vocabulary2
      ->label());

    // Delete terms so we have nothing to reference and try again
    $this->vocabulary
      ->delete();
    $vocabulary2
      ->delete();
    $entity = entity_create('entity_test', array(
      'name' => $this
        ->randomMachineName(),
    ));
    $entity
      ->save();
  }

  /**
   * Tests entity auto create.
   */
  public function testEntityAutoCreate() {

    // The term entity is unsaved here.
    $term = Term::create(array(
      'name' => $this
        ->randomMachineName(),
      'vid' => $this->term
        ->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $entity = EntityTest::create();

    // Now assign the unsaved term to the field.
    $entity->field_test_taxonomy_term->entity = $term;
    $entity->name->value = $this
      ->randomMachineName();

    // This is equal to storing an entity to tempstore or cache and retrieving
    // it back. An example for this is node preview.
    $entity = serialize($entity);
    $entity = unserialize($entity);

    // And then the entity.
    $entity
      ->save();
    $term = \Drupal::entityManager()
      ->loadEntityByUuid($term
      ->getEntityTypeId(), $term
      ->uuid());
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->id(), $term
      ->id());
  }

  /**
   * Test saving order sequence doesn't matter.
   */
  public function testEntitySaveOrder() {

    // The term entity is unsaved here.
    $term = entity_create('taxonomy_term', array(
      'name' => $this
        ->randomMachineName(),
      'vid' => $this->term
        ->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $entity = entity_create('entity_test');

    // Now assign the unsaved term to the field.
    $entity->field_test_taxonomy_term->entity = $term;
    $entity->name->value = $this
      ->randomMachineName();

    // Now get the field value.
    $value = $entity
      ->get('field_test_taxonomy_term');
    $this
      ->assertTrue(empty($value['target_id']));
    $this
      ->assertNull($entity->field_test_taxonomy_term->target_id);

    // And then set it.
    $entity->field_test_taxonomy_term = $value;

    // Now save the term.
    $term
      ->save();

    // And then the entity.
    $entity
      ->save();
    $this
      ->assertEqual($entity->field_test_taxonomy_term->entity
      ->id(), $term
      ->id());
  }

  /**
   * Tests that the 'handler' field setting stores the proper plugin ID.
   */
  public function testSelectionHandlerSettings() {
    $field_name = Unicode::strtolower($this
      ->randomMachineName());
    $field_storage = FieldStorageConfig::create(array(
      'field_name' => $field_name,
      'entity_type' => 'entity_test',
      'type' => 'entity_reference',
      'settings' => array(
        'target_type' => 'entity_test',
      ),
    ));
    $field_storage
      ->save();

    // Do not specify any value for the 'handler' setting in order to verify
    // that the default handler with the correct derivative is used.
    $field = FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => 'entity_test',
    ));
    $field
      ->save();
    $field = FieldConfig::load($field
      ->id());
    $this
      ->assertEqual($field
      ->getSetting('handler'), 'default:entity_test');

    // Change the target_type in the field storage, and check that the handler
    // was correctly reassigned in the field.
    $field_storage
      ->setSetting('target_type', 'entity_test_rev');
    $field_storage
      ->save();
    $field = FieldConfig::load($field
      ->id());
    $this
      ->assertEqual($field
      ->getSetting('handler'), 'default:entity_test_rev');

    // Change the handler to another, non-derivative plugin.
    $field
      ->setSetting('handler', 'views');
    $field
      ->save();
    $field = FieldConfig::load($field
      ->id());
    $this
      ->assertEqual($field
      ->getSetting('handler'), 'views');

    // Change the target_type in the field storage again, and check that the
    // non-derivative handler was unchanged.
    $field_storage
      ->setSetting('target_type', 'entity_test_rev');
    $field_storage
      ->save();
    $field = FieldConfig::load($field
      ->id());
    $this
      ->assertEqual($field
      ->getSetting('handler'), 'views');
  }

  /**
   * Tests ValidReferenceConstraint with newly created and unsaved entities.
   */
  public function testAutocreateValidation() {

    // The term entity is unsaved here.
    $term = Term::create(array(
      'name' => $this
        ->randomMachineName(),
      'vid' => $this->term
        ->bundle(),
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ));
    $entity = EntityTest::create([
      'field_test_taxonomy_term' => [
        'entity' => $term,
        'target_id' => NULL,
      ],
    ]);
    $errors = $entity
      ->validate();

    // Using target_id of NULL is valid with an unsaved entity.
    $this
      ->assertEqual(0, count($errors));

    // Using target_id of NULL is not valid with a saved entity.
    $term
      ->save();
    $entity = EntityTest::create([
      'field_test_taxonomy_term' => [
        'entity' => $term,
        'target_id' => NULL,
      ],
    ]);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(1, count($errors));
    $this
      ->assertEqual($errors[0]
      ->getMessage(), 'This value should not be null.');
    $this
      ->assertEqual($errors[0]
      ->getPropertyPath(), 'field_test_taxonomy_term.0');

    // This should rectify the issue, favoring the entity over the target_id.
    $entity
      ->save();
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(0, count($errors));

    // Test with an unpublished and unsaved node.
    $title = $this
      ->randomString();
    $node = Node::create([
      'title' => $title,
      'type' => 'node',
      'status' => NODE_NOT_PUBLISHED,
    ]);
    $entity = EntityTest::create([
      'field_test_node' => [
        'entity' => $node,
      ],
    ]);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(1, count($errors));
    $this
      ->assertEqual($errors[0]
      ->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', [
      '%type' => 'node',
      '%label' => $title,
    ]));
    $this
      ->assertEqual($errors[0]
      ->getPropertyPath(), 'field_test_node.0.entity');

    // Publish the node and try again.
    $node
      ->setPublished(TRUE);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(0, count($errors));

    // Test with an unpublished and unsaved comment.
    $title = $this
      ->randomString();
    $comment = Comment::create([
      'subject' => $title,
      'comment_type' => 'comment',
      'status' => 0,
    ]);
    $entity = EntityTest::create([
      'field_test_comment' => [
        'entity' => $comment,
      ],
    ]);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(1, count($errors));
    $this
      ->assertEqual($errors[0]
      ->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', [
      '%type' => 'comment',
      '%label' => $title,
    ]));
    $this
      ->assertEqual($errors[0]
      ->getPropertyPath(), 'field_test_comment.0.entity');

    // Publish the comment and try again.
    $comment
      ->setPublished(TRUE);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(0, count($errors));

    // Test with an inactive and unsaved user.
    $name = $this
      ->randomString();
    $user = User::create([
      'name' => $name,
      'status' => 0,
    ]);
    $entity = EntityTest::create([
      'field_test_user' => [
        'entity' => $user,
      ],
    ]);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(1, count($errors));
    $this
      ->assertEqual($errors[0]
      ->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', [
      '%type' => 'user',
      '%label' => $name,
    ]));
    $this
      ->assertEqual($errors[0]
      ->getPropertyPath(), 'field_test_user.0.entity');

    // Activate the user and try again.
    $user
      ->activate();
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(0, count($errors));

    // Test with a temporary and unsaved file.
    $filename = $this
      ->randomMachineName() . '.txt';
    $file = File::create([
      'filename' => $filename,
      'status' => 0,
    ]);
    $entity = EntityTest::create([
      'field_test_file' => [
        'entity' => $file,
      ],
    ]);
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(1, count($errors));
    $this
      ->assertEqual($errors[0]
      ->getMessage(), new FormattableMarkup('This entity (%type: %label) cannot be referenced.', [
      '%type' => 'file',
      '%label' => $filename,
    ]));
    $this
      ->assertEqual($errors[0]
      ->getPropertyPath(), 'field_test_file.0.entity');

    // Set the file as permanent and try again.
    $file
      ->setPermanent();
    $errors = $entity
      ->validate();
    $this
      ->assertEqual(0, count($errors));
  }

}

Classes

Name	Description
EntityReferenceItemTest	Tests the new entity API for the entity reference field type.