Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\Core\Entity;
|
Chris@0
|
4
|
Chris@0
|
5 use Drupal\Core\Cache\Cache;
|
Chris@0
|
6 use Drupal\Core\Cache\CacheBackendInterface;
|
Chris@0
|
7 use Drupal\Core\Cache\UseCacheBackendTrait;
|
Chris@0
|
8 use Drupal\Core\Extension\ModuleHandlerInterface;
|
Chris@0
|
9 use Drupal\Core\Field\BaseFieldDefinition;
|
Chris@18
|
10 use Drupal\Core\Field\FieldDefinition;
|
Chris@0
|
11 use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;
|
Chris@0
|
12 use Drupal\Core\Language\LanguageManagerInterface;
|
Chris@0
|
13 use Drupal\Core\StringTranslation\StringTranslationTrait;
|
Chris@0
|
14 use Drupal\Core\TypedData\TypedDataManagerInterface;
|
Chris@0
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Manages the discovery of entity fields.
|
Chris@0
|
18 *
|
Chris@0
|
19 * This includes field definitions, base field definitions, and field storage
|
Chris@0
|
20 * definitions.
|
Chris@0
|
21 */
|
Chris@0
|
22 class EntityFieldManager implements EntityFieldManagerInterface {
|
Chris@0
|
23
|
Chris@0
|
24 use UseCacheBackendTrait;
|
Chris@0
|
25 use StringTranslationTrait;
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Extra fields by bundle.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @var array
|
Chris@0
|
31 */
|
Chris@0
|
32 protected $extraFields = [];
|
Chris@0
|
33
|
Chris@0
|
34 /**
|
Chris@0
|
35 * Static cache of base field definitions.
|
Chris@0
|
36 *
|
Chris@0
|
37 * @var array
|
Chris@0
|
38 */
|
Chris@0
|
39 protected $baseFieldDefinitions;
|
Chris@0
|
40
|
Chris@0
|
41 /**
|
Chris@0
|
42 * Static cache of field definitions per bundle and entity type.
|
Chris@0
|
43 *
|
Chris@0
|
44 * @var array
|
Chris@0
|
45 */
|
Chris@0
|
46 protected $fieldDefinitions;
|
Chris@0
|
47
|
Chris@0
|
48 /**
|
Chris@0
|
49 * Static cache of field storage definitions per entity type.
|
Chris@0
|
50 *
|
Chris@0
|
51 * Elements of the array:
|
Chris@0
|
52 * - $entity_type_id: \Drupal\Core\Field\BaseFieldDefinition[]
|
Chris@0
|
53 *
|
Chris@0
|
54 * @var array
|
Chris@0
|
55 */
|
Chris@0
|
56 protected $fieldStorageDefinitions;
|
Chris@0
|
57
|
Chris@0
|
58 /**
|
Chris@18
|
59 * Static cache of active field storage definitions per entity type.
|
Chris@18
|
60 *
|
Chris@18
|
61 * @var array
|
Chris@18
|
62 */
|
Chris@18
|
63 protected $activeFieldStorageDefinitions;
|
Chris@18
|
64
|
Chris@18
|
65 /**
|
Chris@0
|
66 * An array keyed by entity type. Each value is an array whose keys are
|
Chris@0
|
67 * field names and whose value is an array with two entries:
|
Chris@0
|
68 * - type: The field type.
|
Chris@0
|
69 * - bundles: The bundles in which the field appears.
|
Chris@0
|
70 *
|
Chris@12
|
71 * @var array
|
Chris@0
|
72 */
|
Chris@0
|
73 protected $fieldMap = [];
|
Chris@0
|
74
|
Chris@0
|
75 /**
|
Chris@0
|
76 * An array keyed by field type. Each value is an array whose key are entity
|
Chris@0
|
77 * types including arrays in the same form that $fieldMap.
|
Chris@0
|
78 *
|
Chris@0
|
79 * It helps access the mapping between types and fields by the field type.
|
Chris@0
|
80 *
|
Chris@0
|
81 * @var array
|
Chris@0
|
82 */
|
Chris@0
|
83 protected $fieldMapByFieldType = [];
|
Chris@0
|
84
|
Chris@0
|
85 /**
|
Chris@0
|
86 * The typed data manager.
|
Chris@0
|
87 *
|
Chris@0
|
88 * @var \Drupal\Core\TypedData\TypedDataManagerInterface
|
Chris@0
|
89 */
|
Chris@0
|
90 protected $typedDataManager;
|
Chris@0
|
91
|
Chris@0
|
92 /**
|
Chris@0
|
93 * The language manager.
|
Chris@0
|
94 *
|
Chris@0
|
95 * @var \Drupal\Core\Language\LanguageManagerInterface
|
Chris@0
|
96 */
|
Chris@0
|
97 protected $languageManager;
|
Chris@0
|
98
|
Chris@0
|
99 /**
|
Chris@0
|
100 * The key-value factory.
|
Chris@0
|
101 *
|
Chris@0
|
102 * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
|
Chris@0
|
103 */
|
Chris@0
|
104 protected $keyValueFactory;
|
Chris@0
|
105
|
Chris@0
|
106 /**
|
Chris@0
|
107 * The module handler.
|
Chris@0
|
108 *
|
Chris@0
|
109 * @var \Drupal\Core\Extension\ModuleHandlerInterface
|
Chris@0
|
110 */
|
Chris@0
|
111 protected $moduleHandler;
|
Chris@0
|
112
|
Chris@0
|
113 /**
|
Chris@0
|
114 * The entity type manager.
|
Chris@0
|
115 *
|
Chris@0
|
116 * @var \Drupal\Core\Entity\EntityTypeManagerInterface
|
Chris@0
|
117 */
|
Chris@0
|
118 protected $entityTypeManager;
|
Chris@0
|
119
|
Chris@0
|
120 /**
|
Chris@0
|
121 * The entity type bundle info.
|
Chris@0
|
122 *
|
Chris@0
|
123 * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
|
Chris@0
|
124 */
|
Chris@0
|
125 protected $entityTypeBundleInfo;
|
Chris@0
|
126
|
Chris@0
|
127 /**
|
Chris@0
|
128 * The entity display repository.
|
Chris@0
|
129 *
|
Chris@0
|
130 * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
|
Chris@0
|
131 */
|
Chris@0
|
132 protected $entityDisplayRepository;
|
Chris@0
|
133
|
Chris@0
|
134 /**
|
Chris@0
|
135 * Constructs a new EntityFieldManager.
|
Chris@0
|
136 *
|
Chris@0
|
137 * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
|
Chris@0
|
138 * The entity type manager.
|
Chris@0
|
139 * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
|
Chris@0
|
140 * The entity type bundle info.
|
Chris@0
|
141 * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
|
Chris@0
|
142 * The entity display repository.
|
Chris@0
|
143 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
|
Chris@0
|
144 * The typed data manager.
|
Chris@0
|
145 * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
|
Chris@0
|
146 * The language manager.
|
Chris@0
|
147 * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
|
Chris@0
|
148 * The key-value factory.
|
Chris@0
|
149 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
|
Chris@0
|
150 * The module handler.
|
Chris@0
|
151 * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
|
Chris@0
|
152 * The cache backend.
|
Chris@0
|
153 */
|
Chris@0
|
154 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
|
155 $this->entityTypeManager = $entity_type_manager;
|
Chris@0
|
156 $this->entityTypeBundleInfo = $entity_type_bundle_info;
|
Chris@0
|
157 $this->entityDisplayRepository = $entity_display_repository;
|
Chris@0
|
158
|
Chris@0
|
159 $this->typedDataManager = $typed_data_manager;
|
Chris@0
|
160 $this->languageManager = $language_manager;
|
Chris@0
|
161 $this->keyValueFactory = $key_value_factory;
|
Chris@0
|
162 $this->moduleHandler = $module_handler;
|
Chris@0
|
163 $this->cacheBackend = $cache_backend;
|
Chris@0
|
164 }
|
Chris@0
|
165
|
Chris@0
|
166 /**
|
Chris@0
|
167 * {@inheritdoc}
|
Chris@0
|
168 */
|
Chris@0
|
169 public function getBaseFieldDefinitions($entity_type_id) {
|
Chris@0
|
170 // Check the static cache.
|
Chris@0
|
171 if (!isset($this->baseFieldDefinitions[$entity_type_id])) {
|
Chris@0
|
172 // Not prepared, try to load from cache.
|
Chris@0
|
173 $cid = 'entity_base_field_definitions:' . $entity_type_id . ':' . $this->languageManager->getCurrentLanguage()->getId();
|
Chris@0
|
174 if ($cache = $this->cacheGet($cid)) {
|
Chris@0
|
175 $this->baseFieldDefinitions[$entity_type_id] = $cache->data;
|
Chris@0
|
176 }
|
Chris@0
|
177 else {
|
Chris@0
|
178 // Rebuild the definitions and put it into the cache.
|
Chris@0
|
179 $this->baseFieldDefinitions[$entity_type_id] = $this->buildBaseFieldDefinitions($entity_type_id);
|
Chris@0
|
180 $this->cacheSet($cid, $this->baseFieldDefinitions[$entity_type_id], Cache::PERMANENT, ['entity_types', 'entity_field_info']);
|
Chris@0
|
181 }
|
Chris@0
|
182 }
|
Chris@0
|
183 return $this->baseFieldDefinitions[$entity_type_id];
|
Chris@0
|
184 }
|
Chris@0
|
185
|
Chris@0
|
186 /**
|
Chris@0
|
187 * Builds base field definitions for an entity type.
|
Chris@0
|
188 *
|
Chris@0
|
189 * @param string $entity_type_id
|
Chris@0
|
190 * The entity type ID. Only entity types that implement
|
Chris@0
|
191 * \Drupal\Core\Entity\FieldableEntityInterface are supported.
|
Chris@0
|
192 *
|
Chris@0
|
193 * @return \Drupal\Core\Field\FieldDefinitionInterface[]
|
Chris@0
|
194 * An array of field definitions, keyed by field name.
|
Chris@0
|
195 *
|
Chris@0
|
196 * @throws \LogicException
|
Chris@0
|
197 * Thrown if a config entity type is given or if one of the entity keys is
|
Chris@0
|
198 * flagged as translatable.
|
Chris@0
|
199 */
|
Chris@0
|
200 protected function buildBaseFieldDefinitions($entity_type_id) {
|
Chris@14
|
201 /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type */
|
Chris@0
|
202 $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
|
Chris@0
|
203 $class = $entity_type->getClass();
|
Chris@14
|
204 /** @var string[] $keys */
|
Chris@0
|
205 $keys = array_filter($entity_type->getKeys());
|
Chris@0
|
206
|
Chris@0
|
207 // Fail with an exception for non-fieldable entity types.
|
Chris@0
|
208 if (!$entity_type->entityClassImplements(FieldableEntityInterface::class)) {
|
Chris@0
|
209 throw new \LogicException("Getting the base fields is not supported for entity type {$entity_type->getLabel()}.");
|
Chris@0
|
210 }
|
Chris@0
|
211
|
Chris@0
|
212 // Retrieve base field definitions.
|
Chris@0
|
213 /** @var \Drupal\Core\Field\FieldStorageDefinitionInterface[] $base_field_definitions */
|
Chris@0
|
214 $base_field_definitions = $class::baseFieldDefinitions($entity_type);
|
Chris@0
|
215
|
Chris@0
|
216 // Make sure translatable entity types are correctly defined.
|
Chris@0
|
217 if ($entity_type->isTranslatable()) {
|
Chris@0
|
218 // The langcode field should always be translatable if the entity type is.
|
Chris@0
|
219 if (isset($keys['langcode']) && isset($base_field_definitions[$keys['langcode']])) {
|
Chris@0
|
220 $base_field_definitions[$keys['langcode']]->setTranslatable(TRUE);
|
Chris@0
|
221 }
|
Chris@0
|
222 // A default_langcode field should always be defined.
|
Chris@0
|
223 if (!isset($base_field_definitions[$keys['default_langcode']])) {
|
Chris@0
|
224 $base_field_definitions[$keys['default_langcode']] = BaseFieldDefinition::create('boolean')
|
Chris@0
|
225 ->setLabel($this->t('Default translation'))
|
Chris@0
|
226 ->setDescription($this->t('A flag indicating whether this is the default translation.'))
|
Chris@0
|
227 ->setTranslatable(TRUE)
|
Chris@0
|
228 ->setRevisionable(TRUE)
|
Chris@0
|
229 ->setDefaultValue(TRUE);
|
Chris@0
|
230 }
|
Chris@0
|
231 }
|
Chris@0
|
232
|
Chris@0
|
233 // Make sure that revisionable entity types are correctly defined.
|
Chris@14
|
234 if ($entity_type->isRevisionable()) {
|
Chris@14
|
235 // Disable the BC layer to prevent a recursion, this only needs the
|
Chris@14
|
236 // revision_default key that is always set.
|
Chris@14
|
237 $field_name = $entity_type->getRevisionMetadataKeys(FALSE)['revision_default'];
|
Chris@14
|
238 $base_field_definitions[$field_name] = BaseFieldDefinition::create('boolean')
|
Chris@14
|
239 ->setLabel($this->t('Default revision'))
|
Chris@14
|
240 ->setDescription($this->t('A flag indicating whether this was a default revision when it was saved.'))
|
Chris@14
|
241 ->setStorageRequired(TRUE)
|
Chris@14
|
242 ->setInternal(TRUE)
|
Chris@14
|
243 ->setTranslatable(FALSE)
|
Chris@14
|
244 ->setRevisionable(TRUE);
|
Chris@14
|
245 }
|
Chris@14
|
246
|
Chris@14
|
247 // Make sure that revisionable and translatable entity types are correctly
|
Chris@14
|
248 // defined.
|
Chris@0
|
249 if ($entity_type->isRevisionable() && $entity_type->isTranslatable()) {
|
Chris@0
|
250 // The 'revision_translation_affected' field should always be defined.
|
Chris@0
|
251 // This field has been added unconditionally in Drupal 8.4.0 and it is
|
Chris@0
|
252 // overriding any pre-existing definition on purpose so that any
|
Chris@0
|
253 // differences are immediately available in the status report.
|
Chris@0
|
254 $base_field_definitions[$keys['revision_translation_affected']] = BaseFieldDefinition::create('boolean')
|
Chris@0
|
255 ->setLabel($this->t('Revision translation affected'))
|
Chris@0
|
256 ->setDescription($this->t('Indicates if the last edit of a translation belongs to current revision.'))
|
Chris@0
|
257 ->setReadOnly(TRUE)
|
Chris@0
|
258 ->setRevisionable(TRUE)
|
Chris@0
|
259 ->setTranslatable(TRUE);
|
Chris@0
|
260 }
|
Chris@0
|
261
|
Chris@0
|
262 // Assign base field definitions the entity type provider.
|
Chris@0
|
263 $provider = $entity_type->getProvider();
|
Chris@0
|
264 foreach ($base_field_definitions as $definition) {
|
Chris@0
|
265 // @todo Remove this check once FieldDefinitionInterface exposes a proper
|
Chris@0
|
266 // provider setter. See https://www.drupal.org/node/2225961.
|
Chris@0
|
267 if ($definition instanceof BaseFieldDefinition) {
|
Chris@0
|
268 $definition->setProvider($provider);
|
Chris@0
|
269 }
|
Chris@0
|
270 }
|
Chris@0
|
271
|
Chris@0
|
272 // Retrieve base field definitions from modules.
|
Chris@0
|
273 foreach ($this->moduleHandler->getImplementations('entity_base_field_info') as $module) {
|
Chris@0
|
274 $module_definitions = $this->moduleHandler->invoke($module, 'entity_base_field_info', [$entity_type]);
|
Chris@0
|
275 if (!empty($module_definitions)) {
|
Chris@0
|
276 // Ensure the provider key actually matches the name of the provider
|
Chris@0
|
277 // defining the field.
|
Chris@0
|
278 foreach ($module_definitions as $field_name => $definition) {
|
Chris@0
|
279 // @todo Remove this check once FieldDefinitionInterface exposes a
|
Chris@0
|
280 // proper provider setter. See https://www.drupal.org/node/2225961.
|
Chris@0
|
281 if ($definition instanceof BaseFieldDefinition && $definition->getProvider() == NULL) {
|
Chris@0
|
282 $definition->setProvider($module);
|
Chris@0
|
283 }
|
Chris@0
|
284 $base_field_definitions[$field_name] = $definition;
|
Chris@0
|
285 }
|
Chris@0
|
286 }
|
Chris@0
|
287 }
|
Chris@0
|
288
|
Chris@0
|
289 // Automatically set the field name, target entity type and bundle
|
Chris@0
|
290 // for non-configurable fields.
|
Chris@0
|
291 foreach ($base_field_definitions as $field_name => $base_field_definition) {
|
Chris@0
|
292 if ($base_field_definition instanceof BaseFieldDefinition) {
|
Chris@0
|
293 $base_field_definition->setName($field_name);
|
Chris@0
|
294 $base_field_definition->setTargetEntityTypeId($entity_type_id);
|
Chris@0
|
295 $base_field_definition->setTargetBundle(NULL);
|
Chris@0
|
296 }
|
Chris@0
|
297 }
|
Chris@0
|
298
|
Chris@0
|
299 // Invoke alter hook.
|
Chris@0
|
300 $this->moduleHandler->alter('entity_base_field_info', $base_field_definitions, $entity_type);
|
Chris@0
|
301
|
Chris@0
|
302 // Ensure defined entity keys are there and have proper revisionable and
|
Chris@0
|
303 // translatable values.
|
Chris@0
|
304 foreach (array_intersect_key($keys, array_flip(['id', 'revision', 'uuid', 'bundle'])) as $key => $field_name) {
|
Chris@0
|
305 if (!isset($base_field_definitions[$field_name])) {
|
Chris@0
|
306 throw new \LogicException("The $field_name field definition does not exist and it is used as $key entity key.");
|
Chris@0
|
307 }
|
Chris@0
|
308 if ($base_field_definitions[$field_name]->isRevisionable()) {
|
Chris@0
|
309 throw new \LogicException("The {$base_field_definitions[$field_name]->getLabel()} field cannot be revisionable as it is used as $key entity key.");
|
Chris@0
|
310 }
|
Chris@0
|
311 if ($base_field_definitions[$field_name]->isTranslatable()) {
|
Chris@0
|
312 throw new \LogicException("The {$base_field_definitions[$field_name]->getLabel()} field cannot be translatable as it is used as $key entity key.");
|
Chris@0
|
313 }
|
Chris@0
|
314 }
|
Chris@0
|
315
|
Chris@0
|
316 // Make sure translatable entity types define the "langcode" field properly.
|
Chris@0
|
317 if ($entity_type->isTranslatable() && (!isset($keys['langcode']) || !isset($base_field_definitions[$keys['langcode']]) || !$base_field_definitions[$keys['langcode']]->isTranslatable())) {
|
Chris@0
|
318 throw new \LogicException("The {$entity_type->getLabel()} entity type cannot be translatable as it does not define a translatable \"langcode\" field.");
|
Chris@0
|
319 }
|
Chris@0
|
320
|
Chris@0
|
321 return $base_field_definitions;
|
Chris@0
|
322 }
|
Chris@0
|
323
|
Chris@0
|
324 /**
|
Chris@0
|
325 * {@inheritdoc}
|
Chris@0
|
326 */
|
Chris@0
|
327 public function getFieldDefinitions($entity_type_id, $bundle) {
|
Chris@0
|
328 if (!isset($this->fieldDefinitions[$entity_type_id][$bundle])) {
|
Chris@0
|
329 $base_field_definitions = $this->getBaseFieldDefinitions($entity_type_id);
|
Chris@0
|
330 // Not prepared, try to load from cache.
|
Chris@0
|
331 $cid = 'entity_bundle_field_definitions:' . $entity_type_id . ':' . $bundle . ':' . $this->languageManager->getCurrentLanguage()->getId();
|
Chris@0
|
332 if ($cache = $this->cacheGet($cid)) {
|
Chris@0
|
333 $bundle_field_definitions = $cache->data;
|
Chris@0
|
334 }
|
Chris@0
|
335 else {
|
Chris@0
|
336 // Rebuild the definitions and put it into the cache.
|
Chris@0
|
337 $bundle_field_definitions = $this->buildBundleFieldDefinitions($entity_type_id, $bundle, $base_field_definitions);
|
Chris@0
|
338 $this->cacheSet($cid, $bundle_field_definitions, Cache::PERMANENT, ['entity_types', 'entity_field_info']);
|
Chris@0
|
339 }
|
Chris@0
|
340 // Field definitions consist of the bundle specific overrides and the
|
Chris@0
|
341 // base fields, merge them together. Use array_replace() to replace base
|
Chris@0
|
342 // fields with by bundle overrides and keep them in order, append
|
Chris@0
|
343 // additional by bundle fields.
|
Chris@0
|
344 $this->fieldDefinitions[$entity_type_id][$bundle] = array_replace($base_field_definitions, $bundle_field_definitions);
|
Chris@0
|
345 }
|
Chris@0
|
346 return $this->fieldDefinitions[$entity_type_id][$bundle];
|
Chris@0
|
347 }
|
Chris@0
|
348
|
Chris@0
|
349 /**
|
Chris@0
|
350 * Builds field definitions for a specific bundle within an entity type.
|
Chris@0
|
351 *
|
Chris@0
|
352 * @param string $entity_type_id
|
Chris@0
|
353 * The entity type ID. Only entity types that implement
|
Chris@0
|
354 * \Drupal\Core\Entity\FieldableEntityInterface are supported.
|
Chris@0
|
355 * @param string $bundle
|
Chris@0
|
356 * The bundle.
|
Chris@0
|
357 * @param \Drupal\Core\Field\FieldDefinitionInterface[] $base_field_definitions
|
Chris@0
|
358 * The list of base field definitions.
|
Chris@0
|
359 *
|
Chris@0
|
360 * @return \Drupal\Core\Field\FieldDefinitionInterface[]
|
Chris@0
|
361 * An array of bundle field definitions, keyed by field name. Does
|
Chris@0
|
362 * not include base fields.
|
Chris@0
|
363 */
|
Chris@0
|
364 protected function buildBundleFieldDefinitions($entity_type_id, $bundle, array $base_field_definitions) {
|
Chris@0
|
365 $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
|
Chris@0
|
366 $class = $entity_type->getClass();
|
Chris@0
|
367
|
Chris@0
|
368 // Allow the entity class to provide bundle fields and bundle-specific
|
Chris@0
|
369 // overrides of base fields.
|
Chris@0
|
370 $bundle_field_definitions = $class::bundleFieldDefinitions($entity_type, $bundle, $base_field_definitions);
|
Chris@0
|
371
|
Chris@0
|
372 // Load base field overrides from configuration. These take precedence over
|
Chris@0
|
373 // base field overrides returned above.
|
Chris@0
|
374 $base_field_override_ids = array_map(function ($field_name) use ($entity_type_id, $bundle) {
|
Chris@0
|
375 return $entity_type_id . '.' . $bundle . '.' . $field_name;
|
Chris@0
|
376 }, array_keys($base_field_definitions));
|
Chris@0
|
377 $base_field_overrides = $this->entityTypeManager->getStorage('base_field_override')->loadMultiple($base_field_override_ids);
|
Chris@0
|
378 foreach ($base_field_overrides as $base_field_override) {
|
Chris@0
|
379 /** @var \Drupal\Core\Field\Entity\BaseFieldOverride $base_field_override */
|
Chris@0
|
380 $field_name = $base_field_override->getName();
|
Chris@0
|
381 $bundle_field_definitions[$field_name] = $base_field_override;
|
Chris@0
|
382 }
|
Chris@0
|
383
|
Chris@0
|
384 $provider = $entity_type->getProvider();
|
Chris@0
|
385 foreach ($bundle_field_definitions as $definition) {
|
Chris@0
|
386 // @todo Remove this check once FieldDefinitionInterface exposes a proper
|
Chris@0
|
387 // provider setter. See https://www.drupal.org/node/2225961.
|
Chris@0
|
388 if ($definition instanceof BaseFieldDefinition) {
|
Chris@0
|
389 $definition->setProvider($provider);
|
Chris@0
|
390 }
|
Chris@0
|
391 }
|
Chris@0
|
392
|
Chris@0
|
393 // Retrieve base field definitions from modules.
|
Chris@0
|
394 foreach ($this->moduleHandler->getImplementations('entity_bundle_field_info') as $module) {
|
Chris@0
|
395 $module_definitions = $this->moduleHandler->invoke($module, 'entity_bundle_field_info', [$entity_type, $bundle, $base_field_definitions]);
|
Chris@0
|
396 if (!empty($module_definitions)) {
|
Chris@0
|
397 // Ensure the provider key actually matches the name of the provider
|
Chris@0
|
398 // defining the field.
|
Chris@0
|
399 foreach ($module_definitions as $field_name => $definition) {
|
Chris@0
|
400 // @todo Remove this check once FieldDefinitionInterface exposes a
|
Chris@0
|
401 // proper provider setter. See https://www.drupal.org/node/2225961.
|
Chris@0
|
402 if ($definition instanceof BaseFieldDefinition) {
|
Chris@0
|
403 $definition->setProvider($module);
|
Chris@0
|
404 }
|
Chris@0
|
405 $bundle_field_definitions[$field_name] = $definition;
|
Chris@0
|
406 }
|
Chris@0
|
407 }
|
Chris@0
|
408 }
|
Chris@0
|
409
|
Chris@0
|
410 // Automatically set the field name, target entity type and bundle
|
Chris@0
|
411 // for non-configurable fields.
|
Chris@0
|
412 foreach ($bundle_field_definitions as $field_name => $field_definition) {
|
Chris@0
|
413 if ($field_definition instanceof BaseFieldDefinition) {
|
Chris@0
|
414 $field_definition->setName($field_name);
|
Chris@0
|
415 $field_definition->setTargetEntityTypeId($entity_type_id);
|
Chris@18
|
416 }
|
Chris@18
|
417 if ($field_definition instanceof BaseFieldDefinition || $field_definition instanceof FieldDefinition) {
|
Chris@0
|
418 $field_definition->setTargetBundle($bundle);
|
Chris@0
|
419 }
|
Chris@0
|
420 }
|
Chris@0
|
421
|
Chris@0
|
422 // Invoke 'per bundle' alter hook.
|
Chris@0
|
423 $this->moduleHandler->alter('entity_bundle_field_info', $bundle_field_definitions, $entity_type, $bundle);
|
Chris@0
|
424
|
Chris@0
|
425 return $bundle_field_definitions;
|
Chris@0
|
426 }
|
Chris@0
|
427
|
Chris@0
|
428 /**
|
Chris@0
|
429 * {@inheritdoc}
|
Chris@0
|
430 */
|
Chris@0
|
431 public function getFieldStorageDefinitions($entity_type_id) {
|
Chris@0
|
432 if (!isset($this->fieldStorageDefinitions[$entity_type_id])) {
|
Chris@0
|
433 $this->fieldStorageDefinitions[$entity_type_id] = [];
|
Chris@0
|
434 // Add all non-computed base fields.
|
Chris@0
|
435 foreach ($this->getBaseFieldDefinitions($entity_type_id) as $field_name => $definition) {
|
Chris@0
|
436 if (!$definition->isComputed()) {
|
Chris@0
|
437 $this->fieldStorageDefinitions[$entity_type_id][$field_name] = $definition;
|
Chris@0
|
438 }
|
Chris@0
|
439 }
|
Chris@0
|
440 // Not prepared, try to load from cache.
|
Chris@0
|
441 $cid = 'entity_field_storage_definitions:' . $entity_type_id . ':' . $this->languageManager->getCurrentLanguage()->getId();
|
Chris@0
|
442 if ($cache = $this->cacheGet($cid)) {
|
Chris@0
|
443 $field_storage_definitions = $cache->data;
|
Chris@0
|
444 }
|
Chris@0
|
445 else {
|
Chris@0
|
446 // Rebuild the definitions and put it into the cache.
|
Chris@0
|
447 $field_storage_definitions = $this->buildFieldStorageDefinitions($entity_type_id);
|
Chris@0
|
448 $this->cacheSet($cid, $field_storage_definitions, Cache::PERMANENT, ['entity_types', 'entity_field_info']);
|
Chris@0
|
449 }
|
Chris@0
|
450 $this->fieldStorageDefinitions[$entity_type_id] += $field_storage_definitions;
|
Chris@0
|
451 }
|
Chris@0
|
452 return $this->fieldStorageDefinitions[$entity_type_id];
|
Chris@0
|
453 }
|
Chris@0
|
454
|
Chris@0
|
455 /**
|
Chris@18
|
456 * Gets the active field storage definitions for a content entity type.
|
Chris@18
|
457 *
|
Chris@18
|
458 * @param string $entity_type_id
|
Chris@18
|
459 * The entity type ID. Only content entities are supported.
|
Chris@18
|
460 *
|
Chris@18
|
461 * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
|
Chris@18
|
462 * An array of field storage definitions that are active in the current
|
Chris@18
|
463 * request, keyed by field name.
|
Chris@18
|
464 *
|
Chris@18
|
465 * @internal
|
Chris@18
|
466 */
|
Chris@18
|
467 public function getActiveFieldStorageDefinitions($entity_type_id) {
|
Chris@18
|
468 if (!isset($this->activeFieldStorageDefinitions[$entity_type_id])) {
|
Chris@18
|
469 $this->activeFieldStorageDefinitions[$entity_type_id] = $this->keyValueFactory->get('entity.definitions.installed')->get($entity_type_id . '.field_storage_definitions', []);
|
Chris@18
|
470 }
|
Chris@18
|
471 return $this->activeFieldStorageDefinitions[$entity_type_id] ?: $this->getFieldStorageDefinitions($entity_type_id);
|
Chris@18
|
472 }
|
Chris@18
|
473
|
Chris@18
|
474 /**
|
Chris@0
|
475 * {@inheritdoc}
|
Chris@0
|
476 */
|
Chris@0
|
477 public function setFieldMap(array $field_map) {
|
Chris@0
|
478 $this->fieldMap = $field_map;
|
Chris@0
|
479 return $this;
|
Chris@0
|
480 }
|
Chris@0
|
481
|
Chris@0
|
482 /**
|
Chris@0
|
483 * {@inheritdoc}
|
Chris@0
|
484 */
|
Chris@0
|
485 public function getFieldMap() {
|
Chris@0
|
486 if (!$this->fieldMap) {
|
Chris@0
|
487 // Not prepared, try to load from cache.
|
Chris@0
|
488 $cid = 'entity_field_map';
|
Chris@0
|
489 if ($cache = $this->cacheGet($cid)) {
|
Chris@0
|
490 $this->fieldMap = $cache->data;
|
Chris@0
|
491 }
|
Chris@0
|
492 else {
|
Chris@0
|
493 // The field map is built in two steps. First, add all base fields, by
|
Chris@0
|
494 // looping over all fieldable entity types. They always exist for all
|
Chris@0
|
495 // bundles, and we do not expect to have so many different entity
|
Chris@0
|
496 // types for this to become a bottleneck.
|
Chris@0
|
497 foreach ($this->entityTypeManager->getDefinitions() as $entity_type_id => $entity_type) {
|
Chris@0
|
498 if ($entity_type->entityClassImplements(FieldableEntityInterface::class)) {
|
Chris@0
|
499 $bundles = array_keys($this->entityTypeBundleInfo->getBundleInfo($entity_type_id));
|
Chris@0
|
500 foreach ($this->getBaseFieldDefinitions($entity_type_id) as $field_name => $base_field_definition) {
|
Chris@0
|
501 $this->fieldMap[$entity_type_id][$field_name] = [
|
Chris@0
|
502 'type' => $base_field_definition->getType(),
|
Chris@0
|
503 'bundles' => array_combine($bundles, $bundles),
|
Chris@0
|
504 ];
|
Chris@0
|
505 }
|
Chris@0
|
506 }
|
Chris@0
|
507 }
|
Chris@0
|
508
|
Chris@0
|
509 // In the second step, the per-bundle fields are added, based on the
|
Chris@0
|
510 // persistent bundle field map stored in a key value collection. This
|
Chris@0
|
511 // data is managed in the EntityManager::onFieldDefinitionCreate()
|
Chris@0
|
512 // and EntityManager::onFieldDefinitionDelete() methods. Rebuilding this
|
Chris@0
|
513 // information in the same way as base fields would not scale, as the
|
Chris@0
|
514 // time to query would grow exponentially with more fields and bundles.
|
Chris@0
|
515 // A cache would be deleted during cache clears, which is the only time
|
Chris@0
|
516 // it is needed, so a key value collection is used.
|
Chris@0
|
517 $bundle_field_maps = $this->keyValueFactory->get('entity.definitions.bundle_field_map')->getAll();
|
Chris@0
|
518 foreach ($bundle_field_maps as $entity_type_id => $bundle_field_map) {
|
Chris@0
|
519 foreach ($bundle_field_map as $field_name => $map_entry) {
|
Chris@0
|
520 if (!isset($this->fieldMap[$entity_type_id][$field_name])) {
|
Chris@0
|
521 $this->fieldMap[$entity_type_id][$field_name] = $map_entry;
|
Chris@0
|
522 }
|
Chris@0
|
523 else {
|
Chris@0
|
524 $this->fieldMap[$entity_type_id][$field_name]['bundles'] += $map_entry['bundles'];
|
Chris@0
|
525 }
|
Chris@0
|
526 }
|
Chris@0
|
527 }
|
Chris@0
|
528
|
Chris@17
|
529 $this->cacheSet($cid, $this->fieldMap, Cache::PERMANENT, ['entity_types', 'entity_field_info']);
|
Chris@0
|
530 }
|
Chris@0
|
531 }
|
Chris@0
|
532 return $this->fieldMap;
|
Chris@0
|
533 }
|
Chris@0
|
534
|
Chris@0
|
535 /**
|
Chris@0
|
536 * {@inheritdoc}
|
Chris@0
|
537 */
|
Chris@0
|
538 public function getFieldMapByFieldType($field_type) {
|
Chris@0
|
539 if (!isset($this->fieldMapByFieldType[$field_type])) {
|
Chris@0
|
540 $filtered_map = [];
|
Chris@0
|
541 $map = $this->getFieldMap();
|
Chris@0
|
542 foreach ($map as $entity_type => $fields) {
|
Chris@0
|
543 foreach ($fields as $field_name => $field_info) {
|
Chris@0
|
544 if ($field_info['type'] == $field_type) {
|
Chris@0
|
545 $filtered_map[$entity_type][$field_name] = $field_info;
|
Chris@0
|
546 }
|
Chris@0
|
547 }
|
Chris@0
|
548 }
|
Chris@0
|
549 $this->fieldMapByFieldType[$field_type] = $filtered_map;
|
Chris@0
|
550 }
|
Chris@0
|
551 return $this->fieldMapByFieldType[$field_type];
|
Chris@0
|
552 }
|
Chris@0
|
553
|
Chris@0
|
554 /**
|
Chris@0
|
555 * Builds field storage definitions for an entity type.
|
Chris@0
|
556 *
|
Chris@0
|
557 * @param string $entity_type_id
|
Chris@0
|
558 * The entity type ID. Only entity types that implement
|
Chris@0
|
559 * \Drupal\Core\Entity\FieldableEntityInterface are supported
|
Chris@0
|
560 *
|
Chris@0
|
561 * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
|
Chris@0
|
562 * An array of field storage definitions, keyed by field name.
|
Chris@0
|
563 */
|
Chris@0
|
564 protected function buildFieldStorageDefinitions($entity_type_id) {
|
Chris@0
|
565 $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
|
Chris@0
|
566 $field_definitions = [];
|
Chris@0
|
567
|
Chris@0
|
568 // Retrieve base field definitions from modules.
|
Chris@0
|
569 foreach ($this->moduleHandler->getImplementations('entity_field_storage_info') as $module) {
|
Chris@0
|
570 $module_definitions = $this->moduleHandler->invoke($module, 'entity_field_storage_info', [$entity_type]);
|
Chris@0
|
571 if (!empty($module_definitions)) {
|
Chris@0
|
572 // Ensure the provider key actually matches the name of the provider
|
Chris@0
|
573 // defining the field.
|
Chris@0
|
574 foreach ($module_definitions as $field_name => $definition) {
|
Chris@0
|
575 // @todo Remove this check once FieldDefinitionInterface exposes a
|
Chris@0
|
576 // proper provider setter. See https://www.drupal.org/node/2225961.
|
Chris@0
|
577 if ($definition instanceof BaseFieldDefinition) {
|
Chris@0
|
578 $definition->setProvider($module);
|
Chris@0
|
579 }
|
Chris@0
|
580 $field_definitions[$field_name] = $definition;
|
Chris@0
|
581 }
|
Chris@0
|
582 }
|
Chris@0
|
583 }
|
Chris@0
|
584
|
Chris@0
|
585 // Invoke alter hook.
|
Chris@0
|
586 $this->moduleHandler->alter('entity_field_storage_info', $field_definitions, $entity_type);
|
Chris@0
|
587
|
Chris@0
|
588 return $field_definitions;
|
Chris@0
|
589 }
|
Chris@0
|
590
|
Chris@0
|
591 /**
|
Chris@0
|
592 * {@inheritdoc}
|
Chris@0
|
593 */
|
Chris@0
|
594 public function clearCachedFieldDefinitions() {
|
Chris@0
|
595 $this->baseFieldDefinitions = [];
|
Chris@0
|
596 $this->fieldDefinitions = [];
|
Chris@0
|
597 $this->fieldStorageDefinitions = [];
|
Chris@18
|
598 $this->activeFieldStorageDefinitions = [];
|
Chris@0
|
599 $this->fieldMap = [];
|
Chris@0
|
600 $this->fieldMapByFieldType = [];
|
Chris@0
|
601 $this->entityDisplayRepository->clearDisplayModeInfo();
|
Chris@0
|
602 $this->extraFields = [];
|
Chris@0
|
603 Cache::invalidateTags(['entity_field_info']);
|
Chris@0
|
604 // The typed data manager statically caches prototype objects with injected
|
Chris@0
|
605 // definitions, clear those as well.
|
Chris@0
|
606 $this->typedDataManager->clearCachedDefinitions();
|
Chris@0
|
607 }
|
Chris@0
|
608
|
Chris@0
|
609 /**
|
Chris@0
|
610 * {@inheritdoc}
|
Chris@0
|
611 */
|
Chris@0
|
612 public function useCaches($use_caches = FALSE) {
|
Chris@0
|
613 $this->useCaches = $use_caches;
|
Chris@0
|
614 if (!$use_caches) {
|
Chris@0
|
615 $this->fieldDefinitions = [];
|
Chris@0
|
616 $this->baseFieldDefinitions = [];
|
Chris@0
|
617 $this->fieldStorageDefinitions = [];
|
Chris@18
|
618 $this->activeFieldStorageDefinitions = [];
|
Chris@0
|
619 }
|
Chris@0
|
620 }
|
Chris@0
|
621
|
Chris@0
|
622 /**
|
Chris@0
|
623 * {@inheritdoc}
|
Chris@0
|
624 */
|
Chris@0
|
625 public function getExtraFields($entity_type_id, $bundle) {
|
Chris@0
|
626 // Read from the "static" cache.
|
Chris@0
|
627 if (isset($this->extraFields[$entity_type_id][$bundle])) {
|
Chris@0
|
628 return $this->extraFields[$entity_type_id][$bundle];
|
Chris@0
|
629 }
|
Chris@0
|
630
|
Chris@0
|
631 // Read from the persistent cache. Since hook_entity_extra_field_info() and
|
Chris@0
|
632 // hook_entity_extra_field_info_alter() might contain t() calls, we cache
|
Chris@0
|
633 // per language.
|
Chris@0
|
634 $cache_id = 'entity_bundle_extra_fields:' . $entity_type_id . ':' . $bundle . ':' . $this->languageManager->getCurrentLanguage()->getId();
|
Chris@0
|
635 $cached = $this->cacheGet($cache_id);
|
Chris@0
|
636 if ($cached) {
|
Chris@0
|
637 $this->extraFields[$entity_type_id][$bundle] = $cached->data;
|
Chris@0
|
638 return $this->extraFields[$entity_type_id][$bundle];
|
Chris@0
|
639 }
|
Chris@0
|
640
|
Chris@0
|
641 $extra = $this->moduleHandler->invokeAll('entity_extra_field_info');
|
Chris@0
|
642 $this->moduleHandler->alter('entity_extra_field_info', $extra);
|
Chris@0
|
643 $info = isset($extra[$entity_type_id][$bundle]) ? $extra[$entity_type_id][$bundle] : [];
|
Chris@0
|
644 $info += [
|
Chris@0
|
645 'form' => [],
|
Chris@0
|
646 'display' => [],
|
Chris@0
|
647 ];
|
Chris@0
|
648
|
Chris@0
|
649 // Store in the 'static' and persistent caches.
|
Chris@0
|
650 $this->extraFields[$entity_type_id][$bundle] = $info;
|
Chris@0
|
651 $this->cacheSet($cache_id, $info, Cache::PERMANENT, [
|
Chris@0
|
652 'entity_field_info',
|
Chris@0
|
653 ]);
|
Chris@0
|
654
|
Chris@0
|
655 return $this->extraFields[$entity_type_id][$bundle];
|
Chris@0
|
656 }
|
Chris@0
|
657
|
Chris@0
|
658 }
|