Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Cache\Cache;
Chris@0: use Drupal\Core\Cache\CacheBackendInterface;
Chris@0: use Drupal\Core\Cache\UseCacheBackendTrait;
Chris@0: use Drupal\Core\Extension\ModuleHandlerInterface;
Chris@0: use Drupal\Core\Field\BaseFieldDefinition;
Chris@18: use Drupal\Core\Field\FieldDefinition;
Chris@0: use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;
Chris@0: use Drupal\Core\Language\LanguageManagerInterface;
Chris@0: use Drupal\Core\StringTranslation\StringTranslationTrait;
Chris@0: use Drupal\Core\TypedData\TypedDataManagerInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Manages the discovery of entity fields.
Chris@0:  *
Chris@0:  * This includes field definitions, base field definitions, and field storage
Chris@0:  * definitions.
Chris@0:  */
Chris@0: class EntityFieldManager implements EntityFieldManagerInterface {
Chris@0: 
Chris@0:   use UseCacheBackendTrait;
Chris@0:   use StringTranslationTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * Extra fields by bundle.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $extraFields = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * Static cache of base field definitions.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $baseFieldDefinitions;
Chris@0: 
Chris@0:   /**
Chris@0:    * Static cache of field definitions per bundle and entity type.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $fieldDefinitions;
Chris@0: 
Chris@0:   /**
Chris@0:    * Static cache of field storage definitions per entity type.
Chris@0:    *
Chris@0:    * Elements of the array:
Chris@0:    *  - $entity_type_id: \Drupal\Core\Field\BaseFieldDefinition[]
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $fieldStorageDefinitions;
Chris@0: 
Chris@0:   /**
Chris@18:    * Static cache of active field storage definitions per entity type.
Chris@18:    *
Chris@18:    * @var array
Chris@18:    */
Chris@18:   protected $activeFieldStorageDefinitions;
Chris@18: 
Chris@18:   /**
Chris@0:    * An array keyed by entity type. Each value is an array whose keys are
Chris@0:    * field names and whose value is an array with two entries:
Chris@0:    *   - type: The field type.
Chris@0:    *   - bundles: The bundles in which the field appears.
Chris@0:    *
Chris@12:    * @var array
Chris@0:    */
Chris@0:   protected $fieldMap = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * An array keyed by field type. Each value is an array whose key are entity
Chris@0:    * types including arrays in the same form that $fieldMap.
Chris@0:    *
Chris@0:    * It helps access the mapping between types and fields by the field type.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $fieldMapByFieldType = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The typed data manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\TypedData\TypedDataManagerInterface
Chris@0:    */
Chris@0:   protected $typedDataManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The language manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Language\LanguageManagerInterface
Chris@0:    */
Chris@0:   protected $languageManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The key-value factory.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
Chris@0:    */
Chris@0:   protected $keyValueFactory;
Chris@0: 
Chris@0:   /**
Chris@0:    * The module handler.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Extension\ModuleHandlerInterface
Chris@0:    */
Chris@0:   protected $moduleHandler;
Chris@0: 
Chris@0:   /**
Chris@0:    * The entity type manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityTypeManagerInterface
Chris@0:    */
Chris@0:   protected $entityTypeManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The entity type bundle info.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
Chris@0:    */
Chris@0:   protected $entityTypeBundleInfo;
Chris@0: 
Chris@0:   /**
Chris@0:    * The entity display repository.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
Chris@0:    */
Chris@0:   protected $entityDisplayRepository;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new EntityFieldManager.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
Chris@0:    *   The entity type manager.
Chris@0:    * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
Chris@0:    *   The entity type bundle info.
Chris@0:    * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
Chris@0:    *   The entity display repository.
Chris@0:    * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
Chris@0:    *   The typed data manager.
Chris@0:    * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
Chris@0:    *   The language manager.
Chris@0:    * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
Chris@0:    *   The key-value factory.
Chris@0:    * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
Chris@0:    *   The module handler.
Chris@0:    * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
Chris@0:    *   The cache backend.
Chris@0:    */
Chris@0:   public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, EntityDisplayRepositoryInterface $entity_display_repository, TypedDataManagerInterface $typed_data_manager, LanguageManagerInterface $language_manager, KeyValueFactoryInterface $key_value_factory, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend) {
Chris@0:     $this->entityTypeManager = $entity_type_manager;
Chris@0:     $this->entityTypeBundleInfo = $entity_type_bundle_info;
Chris@0:     $this->entityDisplayRepository = $entity_display_repository;
Chris@0: 
Chris@0:     $this->typedDataManager = $typed_data_manager;
Chris@0:     $this->languageManager = $language_manager;
Chris@0:     $this->keyValueFactory = $key_value_factory;
Chris@0:     $this->moduleHandler = $module_handler;
Chris@0:     $this->cacheBackend = $cache_backend;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getBaseFieldDefinitions($entity_type_id) {
Chris@0:     // Check the static cache.
Chris@0:     if (!isset($this->baseFieldDefinitions[$entity_type_id])) {
Chris@0:       // Not prepared, try to load from cache.
Chris@0:       $cid = 'entity_base_field_definitions:' . $entity_type_id . ':' . $this->languageManager->getCurrentLanguage()->getId();
Chris@0:       if ($cache = $this->cacheGet($cid)) {
Chris@0:         $this->baseFieldDefinitions[$entity_type_id] = $cache->data;
Chris@0:       }
Chris@0:       else {
Chris@0:         // Rebuild the definitions and put it into the cache.
Chris@0:         $this->baseFieldDefinitions[$entity_type_id] = $this->buildBaseFieldDefinitions($entity_type_id);
Chris@0:         $this->cacheSet($cid, $this->baseFieldDefinitions[$entity_type_id], Cache::PERMANENT, ['entity_types', 'entity_field_info']);
Chris@0:       }
Chris@0:     }
Chris@0:     return $this->baseFieldDefinitions[$entity_type_id];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Builds base field definitions for an entity type.
Chris@0:    *
Chris@0:    * @param string $entity_type_id
Chris@0:    *   The entity type ID. Only entity types that implement
Chris@0:    *   \Drupal\Core\Entity\FieldableEntityInterface are supported.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Field\FieldDefinitionInterface[]
Chris@0:    *   An array of field definitions, keyed by field name.
Chris@0:    *
Chris@0:    * @throws \LogicException
Chris@0:    *   Thrown if a config entity type is given or if one of the entity keys is
Chris@0:    *   flagged as translatable.
Chris@0:    */
Chris@0:   protected function buildBaseFieldDefinitions($entity_type_id) {
Chris@14:     /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type */
Chris@0:     $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
Chris@0:     $class = $entity_type->getClass();
Chris@14:     /** @var string[] $keys */
Chris@0:     $keys = array_filter($entity_type->getKeys());
Chris@0: 
Chris@0:     // Fail with an exception for non-fieldable entity types.
Chris@0:     if (!$entity_type->entityClassImplements(FieldableEntityInterface::class)) {
Chris@0:       throw new \LogicException("Getting the base fields is not supported for entity type {$entity_type->getLabel()}.");
Chris@0:     }
Chris@0: 
Chris@0:     // Retrieve base field definitions.
Chris@0:     /** @var \Drupal\Core\Field\FieldStorageDefinitionInterface[] $base_field_definitions */
Chris@0:     $base_field_definitions = $class::baseFieldDefinitions($entity_type);
Chris@0: 
Chris@0:     // Make sure translatable entity types are correctly defined.
Chris@0:     if ($entity_type->isTranslatable()) {
Chris@0:       // The langcode field should always be translatable if the entity type is.
Chris@0:       if (isset($keys['langcode']) && isset($base_field_definitions[$keys['langcode']])) {
Chris@0:         $base_field_definitions[$keys['langcode']]->setTranslatable(TRUE);
Chris@0:       }
Chris@0:       // A default_langcode field should always be defined.
Chris@0:       if (!isset($base_field_definitions[$keys['default_langcode']])) {
Chris@0:         $base_field_definitions[$keys['default_langcode']] = BaseFieldDefinition::create('boolean')
Chris@0:           ->setLabel($this->t('Default translation'))
Chris@0:           ->setDescription($this->t('A flag indicating whether this is the default translation.'))
Chris@0:           ->setTranslatable(TRUE)
Chris@0:           ->setRevisionable(TRUE)
Chris@0:           ->setDefaultValue(TRUE);
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Make sure that revisionable entity types are correctly defined.
Chris@14:     if ($entity_type->isRevisionable()) {
Chris@14:       // Disable the BC layer to prevent a recursion, this only needs the
Chris@14:       // revision_default key that is always set.
Chris@14:       $field_name = $entity_type->getRevisionMetadataKeys(FALSE)['revision_default'];
Chris@14:       $base_field_definitions[$field_name] = BaseFieldDefinition::create('boolean')
Chris@14:         ->setLabel($this->t('Default revision'))
Chris@14:         ->setDescription($this->t('A flag indicating whether this was a default revision when it was saved.'))
Chris@14:         ->setStorageRequired(TRUE)
Chris@14:         ->setInternal(TRUE)
Chris@14:         ->setTranslatable(FALSE)
Chris@14:         ->setRevisionable(TRUE);
Chris@14:     }
Chris@14: 
Chris@14:     // Make sure that revisionable and translatable entity types are correctly
Chris@14:     // defined.
Chris@0:     if ($entity_type->isRevisionable() && $entity_type->isTranslatable()) {
Chris@0:       // The 'revision_translation_affected' field should always be defined.
Chris@0:       // This field has been added unconditionally in Drupal 8.4.0 and it is
Chris@0:       // overriding any pre-existing definition on purpose so that any
Chris@0:       // differences are immediately available in the status report.
Chris@0:       $base_field_definitions[$keys['revision_translation_affected']] = BaseFieldDefinition::create('boolean')
Chris@0:         ->setLabel($this->t('Revision translation affected'))
Chris@0:         ->setDescription($this->t('Indicates if the last edit of a translation belongs to current revision.'))
Chris@0:         ->setReadOnly(TRUE)
Chris@0:         ->setRevisionable(TRUE)
Chris@0:         ->setTranslatable(TRUE);
Chris@0:     }
Chris@0: 
Chris@0:     // Assign base field definitions the entity type provider.
Chris@0:     $provider = $entity_type->getProvider();
Chris@0:     foreach ($base_field_definitions as $definition) {
Chris@0:       // @todo Remove this check once FieldDefinitionInterface exposes a proper
Chris@0:       //  provider setter. See https://www.drupal.org/node/2225961.
Chris@0:       if ($definition instanceof BaseFieldDefinition) {
Chris@0:         $definition->setProvider($provider);
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Retrieve base field definitions from modules.
Chris@0:     foreach ($this->moduleHandler->getImplementations('entity_base_field_info') as $module) {
Chris@0:       $module_definitions = $this->moduleHandler->invoke($module, 'entity_base_field_info', [$entity_type]);
Chris@0:       if (!empty($module_definitions)) {
Chris@0:         // Ensure the provider key actually matches the name of the provider
Chris@0:         // defining the field.
Chris@0:         foreach ($module_definitions as $field_name => $definition) {
Chris@0:           // @todo Remove this check once FieldDefinitionInterface exposes a
Chris@0:           //  proper provider setter. See https://www.drupal.org/node/2225961.
Chris@0:           if ($definition instanceof BaseFieldDefinition && $definition->getProvider() == NULL) {
Chris@0:             $definition->setProvider($module);
Chris@0:           }
Chris@0:           $base_field_definitions[$field_name] = $definition;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Automatically set the field name, target entity type and bundle
Chris@0:     // for non-configurable fields.
Chris@0:     foreach ($base_field_definitions as $field_name => $base_field_definition) {
Chris@0:       if ($base_field_definition instanceof BaseFieldDefinition) {
Chris@0:         $base_field_definition->setName($field_name);
Chris@0:         $base_field_definition->setTargetEntityTypeId($entity_type_id);
Chris@0:         $base_field_definition->setTargetBundle(NULL);
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Invoke alter hook.
Chris@0:     $this->moduleHandler->alter('entity_base_field_info', $base_field_definitions, $entity_type);
Chris@0: 
Chris@0:     // Ensure defined entity keys are there and have proper revisionable and
Chris@0:     // translatable values.
Chris@0:     foreach (array_intersect_key($keys, array_flip(['id', 'revision', 'uuid', 'bundle'])) as $key => $field_name) {
Chris@0:       if (!isset($base_field_definitions[$field_name])) {
Chris@0:         throw new \LogicException("The $field_name field definition does not exist and it is used as $key entity key.");
Chris@0:       }
Chris@0:       if ($base_field_definitions[$field_name]->isRevisionable()) {
Chris@0:         throw new \LogicException("The {$base_field_definitions[$field_name]->getLabel()} field cannot be revisionable as it is used as $key entity key.");
Chris@0:       }
Chris@0:       if ($base_field_definitions[$field_name]->isTranslatable()) {
Chris@0:         throw new \LogicException("The {$base_field_definitions[$field_name]->getLabel()} field cannot be translatable as it is used as $key entity key.");
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Make sure translatable entity types define the "langcode" field properly.
Chris@0:     if ($entity_type->isTranslatable() && (!isset($keys['langcode']) || !isset($base_field_definitions[$keys['langcode']]) || !$base_field_definitions[$keys['langcode']]->isTranslatable())) {
Chris@0:       throw new \LogicException("The {$entity_type->getLabel()} entity type cannot be translatable as it does not define a translatable \"langcode\" field.");
Chris@0:     }
Chris@0: 
Chris@0:     return $base_field_definitions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFieldDefinitions($entity_type_id, $bundle) {
Chris@0:     if (!isset($this->fieldDefinitions[$entity_type_id][$bundle])) {
Chris@0:       $base_field_definitions = $this->getBaseFieldDefinitions($entity_type_id);
Chris@0:       // Not prepared, try to load from cache.
Chris@0:       $cid = 'entity_bundle_field_definitions:' . $entity_type_id . ':' . $bundle . ':' . $this->languageManager->getCurrentLanguage()->getId();
Chris@0:       if ($cache = $this->cacheGet($cid)) {
Chris@0:         $bundle_field_definitions = $cache->data;
Chris@0:       }
Chris@0:       else {
Chris@0:         // Rebuild the definitions and put it into the cache.
Chris@0:         $bundle_field_definitions = $this->buildBundleFieldDefinitions($entity_type_id, $bundle, $base_field_definitions);
Chris@0:         $this->cacheSet($cid, $bundle_field_definitions, Cache::PERMANENT, ['entity_types', 'entity_field_info']);
Chris@0:       }
Chris@0:       // Field definitions consist of the bundle specific overrides and the
Chris@0:       // base fields, merge them together. Use array_replace() to replace base
Chris@0:       // fields with by bundle overrides and keep them in order, append
Chris@0:       // additional by bundle fields.
Chris@0:       $this->fieldDefinitions[$entity_type_id][$bundle] = array_replace($base_field_definitions, $bundle_field_definitions);
Chris@0:     }
Chris@0:     return $this->fieldDefinitions[$entity_type_id][$bundle];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Builds field definitions for a specific bundle within an entity type.
Chris@0:    *
Chris@0:    * @param string $entity_type_id
Chris@0:    *   The entity type ID. Only entity types that implement
Chris@0:    *   \Drupal\Core\Entity\FieldableEntityInterface are supported.
Chris@0:    * @param string $bundle
Chris@0:    *   The bundle.
Chris@0:    * @param \Drupal\Core\Field\FieldDefinitionInterface[] $base_field_definitions
Chris@0:    *   The list of base field definitions.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Field\FieldDefinitionInterface[]
Chris@0:    *   An array of bundle field definitions, keyed by field name. Does
Chris@0:    *   not include base fields.
Chris@0:    */
Chris@0:   protected function buildBundleFieldDefinitions($entity_type_id, $bundle, array $base_field_definitions) {
Chris@0:     $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
Chris@0:     $class = $entity_type->getClass();
Chris@0: 
Chris@0:     // Allow the entity class to provide bundle fields and bundle-specific
Chris@0:     // overrides of base fields.
Chris@0:     $bundle_field_definitions = $class::bundleFieldDefinitions($entity_type, $bundle, $base_field_definitions);
Chris@0: 
Chris@0:     // Load base field overrides from configuration. These take precedence over
Chris@0:     // base field overrides returned above.
Chris@0:     $base_field_override_ids = array_map(function ($field_name) use ($entity_type_id, $bundle) {
Chris@0:       return $entity_type_id . '.' . $bundle . '.' . $field_name;
Chris@0:     }, array_keys($base_field_definitions));
Chris@0:     $base_field_overrides = $this->entityTypeManager->getStorage('base_field_override')->loadMultiple($base_field_override_ids);
Chris@0:     foreach ($base_field_overrides as $base_field_override) {
Chris@0:       /** @var \Drupal\Core\Field\Entity\BaseFieldOverride $base_field_override */
Chris@0:       $field_name = $base_field_override->getName();
Chris@0:       $bundle_field_definitions[$field_name] = $base_field_override;
Chris@0:     }
Chris@0: 
Chris@0:     $provider = $entity_type->getProvider();
Chris@0:     foreach ($bundle_field_definitions as $definition) {
Chris@0:       // @todo Remove this check once FieldDefinitionInterface exposes a proper
Chris@0:       //  provider setter. See https://www.drupal.org/node/2225961.
Chris@0:       if ($definition instanceof BaseFieldDefinition) {
Chris@0:         $definition->setProvider($provider);
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Retrieve base field definitions from modules.
Chris@0:     foreach ($this->moduleHandler->getImplementations('entity_bundle_field_info') as $module) {
Chris@0:       $module_definitions = $this->moduleHandler->invoke($module, 'entity_bundle_field_info', [$entity_type, $bundle, $base_field_definitions]);
Chris@0:       if (!empty($module_definitions)) {
Chris@0:         // Ensure the provider key actually matches the name of the provider
Chris@0:         // defining the field.
Chris@0:         foreach ($module_definitions as $field_name => $definition) {
Chris@0:           // @todo Remove this check once FieldDefinitionInterface exposes a
Chris@0:           //  proper provider setter. See https://www.drupal.org/node/2225961.
Chris@0:           if ($definition instanceof BaseFieldDefinition) {
Chris@0:             $definition->setProvider($module);
Chris@0:           }
Chris@0:           $bundle_field_definitions[$field_name] = $definition;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Automatically set the field name, target entity type and bundle
Chris@0:     // for non-configurable fields.
Chris@0:     foreach ($bundle_field_definitions as $field_name => $field_definition) {
Chris@0:       if ($field_definition instanceof BaseFieldDefinition) {
Chris@0:         $field_definition->setName($field_name);
Chris@0:         $field_definition->setTargetEntityTypeId($entity_type_id);
Chris@18:       }
Chris@18:       if ($field_definition instanceof BaseFieldDefinition || $field_definition instanceof FieldDefinition) {
Chris@0:         $field_definition->setTargetBundle($bundle);
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Invoke 'per bundle' alter hook.
Chris@0:     $this->moduleHandler->alter('entity_bundle_field_info', $bundle_field_definitions, $entity_type, $bundle);
Chris@0: 
Chris@0:     return $bundle_field_definitions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFieldStorageDefinitions($entity_type_id) {
Chris@0:     if (!isset($this->fieldStorageDefinitions[$entity_type_id])) {
Chris@0:       $this->fieldStorageDefinitions[$entity_type_id] = [];
Chris@0:       // Add all non-computed base fields.
Chris@0:       foreach ($this->getBaseFieldDefinitions($entity_type_id) as $field_name => $definition) {
Chris@0:         if (!$definition->isComputed()) {
Chris@0:           $this->fieldStorageDefinitions[$entity_type_id][$field_name] = $definition;
Chris@0:         }
Chris@0:       }
Chris@0:       // Not prepared, try to load from cache.
Chris@0:       $cid = 'entity_field_storage_definitions:' . $entity_type_id . ':' . $this->languageManager->getCurrentLanguage()->getId();
Chris@0:       if ($cache = $this->cacheGet($cid)) {
Chris@0:         $field_storage_definitions = $cache->data;
Chris@0:       }
Chris@0:       else {
Chris@0:         // Rebuild the definitions and put it into the cache.
Chris@0:         $field_storage_definitions = $this->buildFieldStorageDefinitions($entity_type_id);
Chris@0:         $this->cacheSet($cid, $field_storage_definitions, Cache::PERMANENT, ['entity_types', 'entity_field_info']);
Chris@0:       }
Chris@0:       $this->fieldStorageDefinitions[$entity_type_id] += $field_storage_definitions;
Chris@0:     }
Chris@0:     return $this->fieldStorageDefinitions[$entity_type_id];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@18:    * Gets the active field storage definitions for a content entity type.
Chris@18:    *
Chris@18:    * @param string $entity_type_id
Chris@18:    *   The entity type ID. Only content entities are supported.
Chris@18:    *
Chris@18:    * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
Chris@18:    *   An array of field storage definitions that are active in the current
Chris@18:    *   request, keyed by field name.
Chris@18:    *
Chris@18:    * @internal
Chris@18:    */
Chris@18:   public function getActiveFieldStorageDefinitions($entity_type_id) {
Chris@18:     if (!isset($this->activeFieldStorageDefinitions[$entity_type_id])) {
Chris@18:       $this->activeFieldStorageDefinitions[$entity_type_id] = $this->keyValueFactory->get('entity.definitions.installed')->get($entity_type_id . '.field_storage_definitions', []);
Chris@18:     }
Chris@18:     return $this->activeFieldStorageDefinitions[$entity_type_id] ?: $this->getFieldStorageDefinitions($entity_type_id);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setFieldMap(array $field_map) {
Chris@0:     $this->fieldMap = $field_map;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFieldMap() {
Chris@0:     if (!$this->fieldMap) {
Chris@0:       // Not prepared, try to load from cache.
Chris@0:       $cid = 'entity_field_map';
Chris@0:       if ($cache = $this->cacheGet($cid)) {
Chris@0:         $this->fieldMap = $cache->data;
Chris@0:       }
Chris@0:       else {
Chris@0:         // The field map is built in two steps. First, add all base fields, by
Chris@0:         // looping over all fieldable entity types. They always exist for all
Chris@0:         // bundles, and we do not expect to have so many different entity
Chris@0:         // types for this to become a bottleneck.
Chris@0:         foreach ($this->entityTypeManager->getDefinitions() as $entity_type_id => $entity_type) {
Chris@0:           if ($entity_type->entityClassImplements(FieldableEntityInterface::class)) {
Chris@0:             $bundles = array_keys($this->entityTypeBundleInfo->getBundleInfo($entity_type_id));
Chris@0:             foreach ($this->getBaseFieldDefinitions($entity_type_id) as $field_name => $base_field_definition) {
Chris@0:               $this->fieldMap[$entity_type_id][$field_name] = [
Chris@0:                 'type' => $base_field_definition->getType(),
Chris@0:                 'bundles' => array_combine($bundles, $bundles),
Chris@0:               ];
Chris@0:             }
Chris@0:           }
Chris@0:         }
Chris@0: 
Chris@0:         // In the second step, the per-bundle fields are added, based on the
Chris@0:         // persistent bundle field map stored in a key value collection. This
Chris@0:         // data is managed in the EntityManager::onFieldDefinitionCreate()
Chris@0:         // and EntityManager::onFieldDefinitionDelete() methods. Rebuilding this
Chris@0:         // information in the same way as base fields would not scale, as the
Chris@0:         // time to query would grow exponentially with more fields and bundles.
Chris@0:         // A cache would be deleted during cache clears, which is the only time
Chris@0:         // it is needed, so a key value collection is used.
Chris@0:         $bundle_field_maps = $this->keyValueFactory->get('entity.definitions.bundle_field_map')->getAll();
Chris@0:         foreach ($bundle_field_maps as $entity_type_id => $bundle_field_map) {
Chris@0:           foreach ($bundle_field_map as $field_name => $map_entry) {
Chris@0:             if (!isset($this->fieldMap[$entity_type_id][$field_name])) {
Chris@0:               $this->fieldMap[$entity_type_id][$field_name] = $map_entry;
Chris@0:             }
Chris@0:             else {
Chris@0:               $this->fieldMap[$entity_type_id][$field_name]['bundles'] += $map_entry['bundles'];
Chris@0:             }
Chris@0:           }
Chris@0:         }
Chris@0: 
Chris@17:         $this->cacheSet($cid, $this->fieldMap, Cache::PERMANENT, ['entity_types', 'entity_field_info']);
Chris@0:       }
Chris@0:     }
Chris@0:     return $this->fieldMap;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFieldMapByFieldType($field_type) {
Chris@0:     if (!isset($this->fieldMapByFieldType[$field_type])) {
Chris@0:       $filtered_map = [];
Chris@0:       $map = $this->getFieldMap();
Chris@0:       foreach ($map as $entity_type => $fields) {
Chris@0:         foreach ($fields as $field_name => $field_info) {
Chris@0:           if ($field_info['type'] == $field_type) {
Chris@0:             $filtered_map[$entity_type][$field_name] = $field_info;
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:       $this->fieldMapByFieldType[$field_type] = $filtered_map;
Chris@0:     }
Chris@0:     return $this->fieldMapByFieldType[$field_type];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Builds field storage definitions for an entity type.
Chris@0:    *
Chris@0:    * @param string $entity_type_id
Chris@0:    *   The entity type ID. Only entity types that implement
Chris@0:    *   \Drupal\Core\Entity\FieldableEntityInterface are supported
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
Chris@0:    *   An array of field storage definitions, keyed by field name.
Chris@0:    */
Chris@0:   protected function buildFieldStorageDefinitions($entity_type_id) {
Chris@0:     $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
Chris@0:     $field_definitions = [];
Chris@0: 
Chris@0:     // Retrieve base field definitions from modules.
Chris@0:     foreach ($this->moduleHandler->getImplementations('entity_field_storage_info') as $module) {
Chris@0:       $module_definitions = $this->moduleHandler->invoke($module, 'entity_field_storage_info', [$entity_type]);
Chris@0:       if (!empty($module_definitions)) {
Chris@0:         // Ensure the provider key actually matches the name of the provider
Chris@0:         // defining the field.
Chris@0:         foreach ($module_definitions as $field_name => $definition) {
Chris@0:           // @todo Remove this check once FieldDefinitionInterface exposes a
Chris@0:           //  proper provider setter. See https://www.drupal.org/node/2225961.
Chris@0:           if ($definition instanceof BaseFieldDefinition) {
Chris@0:             $definition->setProvider($module);
Chris@0:           }
Chris@0:           $field_definitions[$field_name] = $definition;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Invoke alter hook.
Chris@0:     $this->moduleHandler->alter('entity_field_storage_info', $field_definitions, $entity_type);
Chris@0: 
Chris@0:     return $field_definitions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function clearCachedFieldDefinitions() {
Chris@0:     $this->baseFieldDefinitions = [];
Chris@0:     $this->fieldDefinitions = [];
Chris@0:     $this->fieldStorageDefinitions = [];
Chris@18:     $this->activeFieldStorageDefinitions = [];
Chris@0:     $this->fieldMap = [];
Chris@0:     $this->fieldMapByFieldType = [];
Chris@0:     $this->entityDisplayRepository->clearDisplayModeInfo();
Chris@0:     $this->extraFields = [];
Chris@0:     Cache::invalidateTags(['entity_field_info']);
Chris@0:     // The typed data manager statically caches prototype objects with injected
Chris@0:     // definitions, clear those as well.
Chris@0:     $this->typedDataManager->clearCachedDefinitions();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function useCaches($use_caches = FALSE) {
Chris@0:     $this->useCaches = $use_caches;
Chris@0:     if (!$use_caches) {
Chris@0:       $this->fieldDefinitions = [];
Chris@0:       $this->baseFieldDefinitions = [];
Chris@0:       $this->fieldStorageDefinitions = [];
Chris@18:       $this->activeFieldStorageDefinitions = [];
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getExtraFields($entity_type_id, $bundle) {
Chris@0:     // Read from the "static" cache.
Chris@0:     if (isset($this->extraFields[$entity_type_id][$bundle])) {
Chris@0:       return $this->extraFields[$entity_type_id][$bundle];
Chris@0:     }
Chris@0: 
Chris@0:     // Read from the persistent cache. Since hook_entity_extra_field_info() and
Chris@0:     // hook_entity_extra_field_info_alter() might contain t() calls, we cache
Chris@0:     // per language.
Chris@0:     $cache_id = 'entity_bundle_extra_fields:' . $entity_type_id . ':' . $bundle . ':' . $this->languageManager->getCurrentLanguage()->getId();
Chris@0:     $cached = $this->cacheGet($cache_id);
Chris@0:     if ($cached) {
Chris@0:       $this->extraFields[$entity_type_id][$bundle] = $cached->data;
Chris@0:       return $this->extraFields[$entity_type_id][$bundle];
Chris@0:     }
Chris@0: 
Chris@0:     $extra = $this->moduleHandler->invokeAll('entity_extra_field_info');
Chris@0:     $this->moduleHandler->alter('entity_extra_field_info', $extra);
Chris@0:     $info = isset($extra[$entity_type_id][$bundle]) ? $extra[$entity_type_id][$bundle] : [];
Chris@0:     $info += [
Chris@0:       'form' => [],
Chris@0:       'display' => [],
Chris@0:     ];
Chris@0: 
Chris@0:     // Store in the 'static' and persistent caches.
Chris@0:     $this->extraFields[$entity_type_id][$bundle] = $info;
Chris@0:     $this->cacheSet($cache_id, $info, Cache::PERMANENT, [
Chris@0:       'entity_field_info',
Chris@0:     ]);
Chris@0: 
Chris@0:     return $this->extraFields[$entity_type_id][$bundle];
Chris@0:   }
Chris@0: 
Chris@0: }