123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179 |
- <?php
- namespace Drupal\KernelTests\Core\Entity;
- use Drupal\Core\Config\Entity\ConfigEntityInterface;
- use Drupal\Core\Entity\EntityTypeManagerInterface;
- use Drupal\Core\Entity\EntityTypeInterface;
- use Drupal\Core\Entity\TypedData\EntityDataDefinition;
- use Drupal\Core\Entity\TypedData\EntityDataDefinitionInterface;
- use Drupal\Core\Field\BaseFieldDefinition;
- use Drupal\Core\Field\FieldDefinitionInterface;
- use Drupal\Core\TypedData\ComplexDataDefinitionInterface;
- use Drupal\Core\TypedData\DataReferenceDefinition;
- use Drupal\Core\TypedData\DataReferenceDefinitionInterface;
- use Drupal\Core\TypedData\ListDataDefinitionInterface;
- use Drupal\KernelTests\KernelTestBase;
- use Drupal\node\Entity\NodeType;
- /**
- * Tests deriving metadata of entity and field data types.
- *
- * @group Entity
- */
- class EntityTypedDataDefinitionTest extends KernelTestBase {
- /**
- * The typed data manager to use.
- *
- * @var \Drupal\Core\TypedData\TypedDataManager
- */
- protected $typedDataManager;
- /**
- * Modules to enable.
- *
- * @var array
- */
- public static $modules = ['system', 'filter', 'text', 'node', 'user'];
- protected function setUp() {
- parent::setup();
- $this->typedDataManager = $this->container->get('typed_data_manager');
- }
- /**
- * Tests deriving metadata about fields.
- */
- public function testFields() {
- $field_definition = BaseFieldDefinition::create('integer');
- // Fields are lists of complex data.
- $this->assertInstanceOf(ListDataDefinitionInterface::class, $field_definition);
- $this->assertNotInstanceOf(ComplexDataDefinitionInterface::class, $field_definition);
- $field_item_definition = $field_definition->getItemDefinition();
- $this->assertNotInstanceOf(ListDataDefinitionInterface::class, $field_item_definition);
- $this->assertInstanceOf(ComplexDataDefinitionInterface::class, $field_item_definition);
- // Derive metadata about field item properties.
- $this->assertEqual(array_keys($field_item_definition->getPropertyDefinitions()), ['value']);
- $this->assertEqual($field_item_definition->getPropertyDefinition('value')->getDataType(), 'integer');
- $this->assertEqual($field_item_definition->getMainPropertyName(), 'value');
- $this->assertNull($field_item_definition->getPropertyDefinition('invalid'));
- // Test accessing field item property metadata via the field definition.
- $this->assertInstanceOf(FieldDefinitionInterface::class, $field_definition);
- $this->assertEqual(array_keys($field_definition->getPropertyDefinitions()), ['value']);
- $this->assertEqual($field_definition->getPropertyDefinition('value')->getDataType(), 'integer');
- $this->assertEqual($field_definition->getMainPropertyName(), 'value');
- $this->assertNull($field_definition->getPropertyDefinition('invalid'));
- // Test using the definition factory for field item lists and field items.
- $field_item = $this->typedDataManager->createDataDefinition('field_item:integer');
- $this->assertNotInstanceOf(ListDataDefinitionInterface::class, $field_item);
- $this->assertInstanceOf(ComplexDataDefinitionInterface::class, $field_item);
- // Comparison should ignore the internal static cache, so compare the
- // serialized objects instead.
- $this->assertEqual(serialize($field_item_definition), serialize($field_item));
- $field_definition2 = $this->typedDataManager->createListDataDefinition('field_item:integer');
- $this->assertInstanceOf(ListDataDefinitionInterface::class, $field_definition2);
- $this->assertNotInstanceOf(ComplexDataDefinitionInterface::class, $field_definition2);
- $this->assertEqual(serialize($field_definition), serialize($field_definition2));
- }
- /**
- * Tests deriving metadata about entities.
- */
- public function testEntities() {
- NodeType::create([
- 'type' => 'article',
- 'name' => 'Article',
- ])->save();
- $entity_definition = EntityDataDefinition::create('node');
- $bundle_definition = EntityDataDefinition::create('node', 'article');
- // Entities are complex data.
- $this->assertNotInstanceOf(ListDataDefinitionInterface::class, $entity_definition);
- $this->assertInstanceOf(ComplexDataDefinitionInterface::class, $entity_definition);
- // Entity definitions should inherit their labels from the entity type.
- $this->assertEquals('Content', $entity_definition->getLabel());
- $this->assertEquals('Article', $bundle_definition->getLabel());
- $field_definitions = $entity_definition->getPropertyDefinitions();
- // Comparison should ignore the internal static cache, so compare the
- // serialized objects instead.
- $this->assertEqual(serialize($field_definitions), serialize(\Drupal::service('entity_field.manager')->getBaseFieldDefinitions('node')));
- $this->assertEqual($entity_definition->getPropertyDefinition('title')->getItemDefinition()->getDataType(), 'field_item:string');
- $this->assertNull($entity_definition->getMainPropertyName());
- $this->assertNull($entity_definition->getPropertyDefinition('invalid'));
- $entity_definition2 = $this->typedDataManager->createDataDefinition('entity:node');
- $this->assertNotInstanceOf(ListDataDefinitionInterface::class, $entity_definition2);
- $this->assertInstanceOf(ComplexDataDefinitionInterface::class, $entity_definition2);
- $this->assertEqual(serialize($entity_definition), serialize($entity_definition2));
- // Test that the definition factory creates the right definitions for all
- // entity data types variants.
- $this->assertEqual(serialize($this->typedDataManager->createDataDefinition('entity')), serialize(EntityDataDefinition::create()));
- $this->assertEqual(serialize($this->typedDataManager->createDataDefinition('entity:node')), serialize(EntityDataDefinition::create('node')));
- // Config entities don't support typed data.
- $entity_definition = EntityDataDefinition::create('node_type');
- $this->assertEqual([], $entity_definition->getPropertyDefinitions());
- }
- /**
- * Tests deriving metadata from entity references.
- */
- public function testEntityReferences() {
- $reference_definition = DataReferenceDefinition::create('entity');
- $this->assertInstanceOf(DataReferenceDefinitionInterface::class, $reference_definition);
- // Test retrieving metadata about the referenced data.
- $this->assertEqual($reference_definition->getTargetDefinition()->getDataType(), 'entity');
- $this->assertInstanceOf(EntityDataDefinitionInterface::class, $reference_definition->getTargetDefinition());
- // Test that the definition factory creates the right definition object.
- $reference_definition2 = $this->typedDataManager->createDataDefinition('entity_reference');
- $this->assertInstanceOf(DataReferenceDefinitionInterface::class, $reference_definition2);
- $this->assertEqual(serialize($reference_definition2), serialize($reference_definition));
- }
- /**
- * Tests that an entity annotation can mark the data definition as internal.
- *
- * @dataProvider entityDefinitionIsInternalProvider
- */
- public function testEntityDefinitionIsInternal($internal, $expected) {
- $entity_type_id = $this->randomMachineName();
- $entity_type = $this->prophesize(EntityTypeInterface::class);
- $entity_type->entityClassImplements(ConfigEntityInterface::class)->willReturn(FALSE);
- $entity_type->getKey('bundle')->willReturn(FALSE);
- $entity_type->getLabel()->willReturn($this->randomString());
- $entity_type->getConstraints()->willReturn([]);
- $entity_type->isInternal()->willReturn($internal);
- $entity_type->getBundleEntityType()->willReturn(NULL);
- $entity_type_manager = $this->prophesize(EntityTypeManagerInterface::class);
- $entity_type_manager->getDefinitions()->willReturn([$entity_type_id => $entity_type->reveal()]);
- $this->container->set('entity_type.manager', $entity_type_manager->reveal());
- $entity_data_definition = EntityDataDefinition::create($entity_type_id);
- $this->assertSame($expected, $entity_data_definition->isInternal());
- }
- /**
- * Provides test cases for testEntityDefinitionIsInternal.
- */
- public function entityDefinitionIsInternalProvider() {
- return [
- 'internal' => [TRUE, TRUE],
- 'external' => [FALSE, FALSE],
- 'undefined' => [NULL, FALSE],
- ];
- }
- }
|