Verified Commit 42fc80c1 authored by Dave Long's avatar Dave Long
Browse files

Issue #2930736 by rodrigoaguilera, joachim, catch, mglaman, vacho,...

Issue #2930736 by rodrigoaguilera, joachim, catch, mglaman, vacho, ravi.shankar, kristiaanvandeneynde, lendude: EntityViewsData assumes BaseFieldDefinitions where it should use FieldDefinitionInterface
parent fcc93f62
Loading
Loading
Loading
Loading
Loading
+22 −6
Original line number Diff line number Diff line
@@ -56,6 +56,11 @@ class EntityViewsData implements EntityHandlerInterface, EntityViewsDataInterfac
   * The field storage definitions for all base fields of the entity type.
   *
   * @var \Drupal\Core\Field\FieldStorageDefinitionInterface[]
   *
   * @deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. No
   * replacement is provided.
   *
   * @see https://www.drupal.org/node/3240278
   */
  protected $fieldStorageDefinitions;

@@ -116,8 +121,14 @@ public static function createInstance(ContainerInterface $container, EntityTypeI
   * Gets the field storage definitions.
   *
   * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
   *
   * @deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. No
   * replacement is provided.
   *
   * @see https://www.drupal.org/node/3240278
   */
  protected function getFieldStorageDefinitions() {
    @trigger_error(__METHOD__ . '() is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. No replacement is provided. See https://www.drupal.org/node/3240278', E_USER_DEPRECATED);
    if (!isset($this->fieldStorageDefinitions)) {
      $this->fieldStorageDefinitions = $this->entityFieldManager->getFieldStorageDefinitions($this->entityType->id());
    }
@@ -312,8 +323,13 @@ public function getViewsData() {
    // Load all typed data definitions of all fields. This should cover each of
    // the entity base, revision, data tables.
    $field_definitions = $this->entityFieldManager->getBaseFieldDefinitions($this->entityType->id());

    $field_storage_definitions = array_map(function (FieldDefinitionInterface $definition) {
      return $definition->getFieldStorageDefinition();
    }, $field_definitions);

    /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
    $table_mapping = $this->storage->getTableMapping($field_definitions);
    $table_mapping = $this->storage->getTableMapping($field_storage_definitions);
    // Fetch all fields that can appear in both the base table and the data
    // table.
    $duplicate_fields = array_intersect_key($entity_keys, array_flip(['id', 'revision', 'bundle']));
@@ -335,9 +351,9 @@ public function getViewsData() {
      }
    }

    foreach ($field_definitions as $field_definition) {
      if ($table_mapping->requiresDedicatedTableStorage($field_definition->getFieldStorageDefinition())) {
        $table = $table_mapping->getDedicatedDataTableName($field_definition->getFieldStorageDefinition());
    foreach ($field_storage_definitions as $field_storage_definition) {
      if ($table_mapping->requiresDedicatedTableStorage($field_storage_definition)) {
        $table = $table_mapping->getDedicatedDataTableName($field_storage_definition);

        $data[$table]['table']['group'] = $this->entityType->getLabel();
        $data[$table]['table']['provider'] = $this->entityType->getProvider();
@@ -350,7 +366,7 @@ public function getViewsData() {
        ];

        if ($revisionable) {
          $revision_table = $table_mapping->getDedicatedRevisionTableName($field_definition->getFieldStorageDefinition());
          $revision_table = $table_mapping->getDedicatedRevisionTableName($field_storage_definition);

          $data[$revision_table]['table']['group'] = $this->t('@entity_type revision', ['@entity_type' => $this->entityType->getLabel()]);
          $data[$revision_table]['table']['provider'] = $this->entityType->getProvider();
@@ -436,7 +452,7 @@ protected function addEntityLinks(array &$data) {
  protected function mapFieldDefinition($table, $field_name, FieldDefinitionInterface $field_definition, TableMappingInterface $table_mapping, &$table_data) {
    // Create a dummy instance to retrieve property definitions.
    $field_column_mapping = $table_mapping->getColumnNames($field_name);
    $field_schema = $this->getFieldStorageDefinitions()[$field_name]->getSchema();
    $field_schema = $field_definition->getFieldStorageDefinition()->getSchema();

    $field_definition_type = $field_definition->getType();
    // Add all properties to views table data. We need an entry for each
+31 −0
Original line number Diff line number Diff line
@@ -664,6 +664,18 @@ public function testRevisionTableFields(): void {
    ], $data['entity_test_mulrev_revision__string']['table']['join']['entity_test_mulrev_property_revision']);
  }

  /**
   * Tests EntityViewsData deprecations.
   *
   * @group legacy
   */
  public function testDeprecations(): void {
    $this->baseEntityType->setHandlerClass('views_data', EntityViewsDataWithDeprecations::class);
    $this->setUpEntityType($this->baseEntityType, $this->commonBaseFields);
    $this->expectDeprecation('Drupal\views\EntityViewsData::getFieldStorageDefinitions() is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. No replacement is provided. See https://www.drupal.org/node/3240278');
    $this->entityTypeManager->getHandler('entity_test', 'views_data')->getViewsData();
  }

  /**
   * Tests generic stuff per field.
   *
@@ -826,6 +838,25 @@ public function setKey($key, $value) {

}

/**
 * Extend EntityViewsData as a module would do.
 *
 * Include calls to deprecated methods.
 */
class EntityViewsDataWithDeprecations extends EntityViewsData {

  /**
   * {@inheritdoc}
   */
  public function getViewsData() {
    // Deprecated method.
    // @phpstan-ignore-next-line
    $this->getFieldStorageDefinitions();
    return [];
  }

}

/**
 * Generic entity class for our test entity types.
 *