EntityManager.php 44.2 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\Core\Entity\EntityManager.
 */

namespace Drupal\Core\Entity;

10
use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException;
11
use Drupal\Component\Plugin\Exception\PluginNotFoundException;
12
use Drupal\Component\Utility\String;
13
use Drupal\Core\DependencyInjection\ClassResolverInterface;
14
use Drupal\Core\Field\BaseFieldDefinition;
15
use Drupal\Core\Cache\Cache;
16
use Drupal\Core\Cache\CacheBackendInterface;
17 18
use Drupal\Core\Entity\Exception\AmbiguousEntityClassException;
use Drupal\Core\Entity\Exception\NoCorrespondingEntityClassException;
19
use Drupal\Core\Extension\ModuleHandlerInterface;
20 21
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Field\FieldStorageDefinitionListenerInterface;
22
use Drupal\Core\Language\LanguageManagerInterface;
23
use Drupal\Core\Language\LanguageInterface;
24
use Drupal\Core\Plugin\DefaultPluginManager;
25
use Drupal\Core\KeyValueStore\KeyValueStoreInterface;
26
use Drupal\Core\StringTranslation\StringTranslationTrait;
27
use Drupal\Core\StringTranslation\TranslationInterface;
28
use Drupal\Core\TypedData\TranslatableInterface;
29
use Drupal\Core\TypedData\TypedDataManager;
30 31
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
32 33 34 35

/**
 * Manages entity type plugin definitions.
 *
36
 * Each entity type definition array is set in the entity type's
37
 * annotation and altered by hook_entity_type_alter().
38 39
 *
 * The defaults for the plugin definition are provided in
40
 * \Drupal\Core\Entity\EntityManagerInterface::defaults.
41
 *
42 43
 * @see \Drupal\Core\Entity\Annotation\EntityType
 * @see \Drupal\Core\Entity\EntityInterface
44
 * @see \Drupal\Core\Entity\EntityTypeInterface
45
 * @see hook_entity_type_alter()
46
 */
47
class EntityManager extends DefaultPluginManager implements EntityManagerInterface, ContainerAwareInterface {
48 49

  use ContainerAwareTrait;
50
  use StringTranslationTrait;
51

52 53 54 55 56 57 58
  /**
   * Extra fields by bundle.
   *
   * @var array
   */
  protected $extraFields = array();

59
  /**
60
   * Contains instantiated handlers keyed by handler type and entity type.
61 62 63
   *
   * @var array
   */
64
  protected $handlers = array();
65

66
  /**
67
   * Static cache of base field definitions.
68 69 70
   *
   * @var array
   */
71
  protected $baseFieldDefinitions;
72 73 74 75 76 77 78 79

  /**
   * Static cache of field definitions per bundle and entity type.
   *
   * @var array
   */
  protected $fieldDefinitions;

80 81 82 83
  /**
   * Static cache of field storage definitions per entity type.
   *
   * Elements of the array:
84
   *  - $entity_type_id: \Drupal\Core\Field\BaseFieldDefinition[]
85 86 87 88 89
   *
   * @var array
   */
  protected $fieldStorageDefinitions;

90 91 92 93 94 95 96
  /**
   * The string translationManager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $translationManager;

97 98 99 100 101 102 103
  /**
   * The class resolver.
   *
   * @var \Drupal\Core\DependencyInjection\ClassResolverInterface
   */
  protected $classResolver;

104 105 106 107 108 109 110
  /**
   * The typed data manager.
   *
   * @var \Drupal\Core\TypedData\TypedDataManager
   */
  protected $typedDataManager;

111 112 113 114 115 116 117
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

118 119 120 121 122 123 124
  /**
   * The keyvalue collection for tracking installed definitions.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  protected $installedDefinitions;

125
  /**
126 127 128 129 130 131
   * Static cache of bundle information.
   *
   * @var array
   */
  protected $bundleInfo;

132 133 134 135 136 137 138
  /**
   * Static cache of display modes information.
   *
   * @var array
   */
  protected $displayModeInfo = array();

139 140 141 142 143 144 145 146 147 148
  /**
   * An array keyed by entity type. Each value is an array whose keys are
   * field names and whose value is an array with two entries:
   *   - type: The field type.
   *   - bundles: The bundles in which the field appears.
   *
   * @return array
   */
  protected $fieldMap = array();

149 150 151 152 153 154 155 156 157 158
  /**
   * An array keyed by field type. Each value is an array whose key are entity
   * types including arrays in the same form that $fieldMap.
   *
   * It helps access the mapping between types and fields by the field type.
   *
   * @var array
   */
  protected $fieldMapByFieldType = array();

159 160 161 162 163 164 165
  /**
   * Contains cached mappings of class names to entity types.
   *
   * @var array
   */
  protected $classNameEntityTypeMap = array();

166 167
  /**
   * Constructs a new Entity plugin manager.
168
   *
169 170 171
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations,
172 173 174 175
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache backend to use.
176
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
177
   *   The language manager.
178 179
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translation_manager
   *   The string translationManager.
180 181
   * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
   *   The class resolver.
182 183 184 185
   * @param \Drupal\Core\TypedData\TypedDataManager $typed_data_manager
   *   The typed data manager.
   * @param \Drupal\Core\KeyValueStore\KeyValueStoreInterface $installed_definitions
   *   The keyvalue collection for tracking installed definitions.
186
   */
187
  public function __construct(\Traversable $namespaces, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache, LanguageManagerInterface $language_manager, TranslationInterface $translation_manager, ClassResolverInterface $class_resolver, TypedDataManager $typed_data_manager, KeyValueStoreInterface $installed_definitions) {
188
    parent::__construct('Entity', $namespaces, $module_handler, 'Drupal\Core\Entity\EntityInterface', 'Drupal\Core\Entity\Annotation\EntityType');
189

190
    $this->setCacheBackend($cache, 'entity_type', array('entity_types' => TRUE));
191
    $this->alterInfo('entity_type');
192

193
    $this->languageManager = $language_manager;
194
    $this->translationManager = $translation_manager;
195
    $this->classResolver = $class_resolver;
196
    $this->typedDataManager = $typed_data_manager;
197
    $this->installedDefinitions = $installed_definitions;
198 199
  }

200 201 202 203 204
  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions() {
    parent::clearCachedDefinitions();
205 206
    $this->clearCachedBundles();
    $this->clearCachedFieldDefinitions();
207
    $this->classNameEntityTypeMap = array();
208
    $this->handlers = array();
209 210
  }

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
  /**
   * {@inheritdoc}
   */
  protected function findDefinitions() {
    $definitions = $this->discovery->getDefinitions();

    // Directly call the hook implementations to pass the definitions to them
    // by reference, so new entity types can be added.
    foreach ($this->moduleHandler->getImplementations('entity_type_build') as $module) {
      $function = $module . '_' . 'entity_type_build';
      $function($definitions);
    }
    foreach ($definitions as $plugin_id => $definition) {
      $this->processDefinition($definition, $plugin_id);
    }
    if ($this->alterHook) {
      $this->moduleHandler->alter($this->alterHook, $definitions);
    }
    return $definitions;
  }

232
  /**
233
   * {@inheritdoc}
234
   */
235 236
  public function getDefinition($entity_type_id, $exception_on_invalid = TRUE) {
    if (($entity_type = parent::getDefinition($entity_type_id, FALSE)) && class_exists($entity_type->getClass())) {
237
      return $entity_type;
238
    }
239 240 241 242
    elseif (!$exception_on_invalid) {
      return NULL;
    }

243
    throw new PluginNotFoundException($entity_type_id, sprintf('The "%s" entity type does not exist.', $entity_type_id));
244 245
  }

246
  /**
247
   * {@inheritdoc}
248
   */
249
  public function hasHandler($entity_type, $handler_type) {
250
    if ($definition = $this->getDefinition($entity_type, FALSE)) {
251
      return $definition->hasHandlerClass($handler_type);
252
    }
253
    return FALSE;
254 255 256
  }

  /**
257
   * {@inheritdoc}
258
   */
259
  public function getStorage($entity_type) {
260
    return $this->getHandler($entity_type, 'storage');
261 262 263
  }

  /**
264
   * {@inheritdoc}
265
   */
266
  public function getListBuilder($entity_type) {
267
    return $this->getHandler($entity_type, 'list_builder');
268 269 270
  }

  /**
271
   * {@inheritdoc}
272
   */
273
  public function getFormObject($entity_type, $operation) {
274
    if (!isset($this->handlers['form'][$operation][$entity_type])) {
275 276 277
      if (!$class = $this->getDefinition($entity_type, TRUE)->getFormClass($operation)) {
        throw new InvalidPluginDefinitionException($entity_type, sprintf('The "%s" entity type did not specify a "%s" form class.', $entity_type, $operation));
      }
278

279
      $form_object = $this->classResolver->getInstanceFromDefinition($class);
280

281
      $form_object
282
        ->setStringTranslation($this->translationManager)
283 284
        ->setModuleHandler($this->moduleHandler)
        ->setOperation($operation);
285
      $this->handlers['form'][$operation][$entity_type] = $form_object;
286
    }
287
    return $this->handlers['form'][$operation][$entity_type];
288 289 290
  }

  /**
291
   * {@inheritdoc}
292
   */
293
  public function getViewBuilder($entity_type) {
294
    return $this->getHandler($entity_type, 'view_builder');
295 296 297
  }

  /**
298
   * {@inheritdoc}
299
   */
300
  public function getAccessControlHandler($entity_type) {
301
    return $this->getHandler($entity_type, 'access');
302 303 304
  }

  /**
305
   * {@inheritdoc}
306
   */
307 308
  public function getHandler($entity_type, $handler_type) {
    if (!isset($this->handlers[$handler_type][$entity_type])) {
309
      $definition = $this->getDefinition($entity_type);
310
      $class = $definition->getHandlerClass($handler_type);
311
      if (!$class) {
312
        throw new InvalidPluginDefinitionException($entity_type, sprintf('The "%s" entity type did not specify a %s handler.', $entity_type, $handler_type));
313
      }
314 315
      if (is_subclass_of($class, 'Drupal\Core\Entity\EntityHandlerInterface')) {
        $handler = $class::createInstance($this->container, $definition);
316 317
      }
      else {
318
        $handler = new $class($definition);
319
      }
320 321
      if (method_exists($handler, 'setModuleHandler')) {
        $handler->setModuleHandler($this->moduleHandler);
322
      }
323 324
      if (method_exists($handler, 'setStringTranslation')) {
        $handler->setStringTranslation($this->translationManager);
325
      }
326
      $this->handlers[$handler_type][$entity_type] = $handler;
327
    }
328
    return $this->handlers[$handler_type][$entity_type];
329 330
  }

331
  /**
332
   * {@inheritdoc}
333
   */
334 335 336 337 338
  public function getBaseFieldDefinitions($entity_type_id) {
    // Check the static cache.
    if (!isset($this->baseFieldDefinitions[$entity_type_id])) {
      // Not prepared, try to load from cache.
      $cid = 'entity_base_field_definitions:' . $entity_type_id . ':' . $this->languageManager->getCurrentLanguage()->id;
339
      if ($cache = $this->cacheBackend->get($cid)) {
340
        $this->baseFieldDefinitions[$entity_type_id] = $cache->data;
341 342
      }
      else {
343 344
        // Rebuild the definitions and put it into the cache.
        $this->baseFieldDefinitions[$entity_type_id] = $this->buildBaseFieldDefinitions($entity_type_id);
345
        $this->cacheBackend->set($cid, $this->baseFieldDefinitions[$entity_type_id], Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
346 347 348 349 350 351 352 353 354 355
       }
     }
    return $this->baseFieldDefinitions[$entity_type_id];
  }

  /**
   * Builds base field definitions for an entity type.
   *
   * @param string $entity_type_id
   *   The entity type ID. Only entity types that implement
356
   *   \Drupal\Core\Entity\ContentEntityInterface are supported.
357 358 359 360 361
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   An array of field definitions, keyed by field name.
   *
   * @throws \LogicException
362 363
   *   Thrown if a config entity type is given or if one of the entity keys is
   *   flagged as translatable.
364 365 366 367 368
   */
  protected function buildBaseFieldDefinitions($entity_type_id) {
    $entity_type = $this->getDefinition($entity_type_id);
    $class = $entity_type->getClass();

369 370 371 372 373
    // Fail with an exception for config entity types.
    if (!$entity_type->isSubclassOf('\Drupal\Core\Entity\ContentEntityInterface')) {
      throw new \LogicException(String::format('Getting the base fields is not supported for entity type @type.', array('@type' => $entity_type->getLabel())));
    }

374
    // Retrieve base field definitions and assign them the entity type provider.
375
    $base_field_definitions = $class::baseFieldDefinitions($entity_type);
376 377
    $provider = $entity_type->getProvider();
    foreach ($base_field_definitions as $definition) {
378 379
      // @todo Remove this check once FieldDefinitionInterface exposes a proper
      //  provider setter. See https://drupal.org/node/2225961.
380
      if ($definition instanceof BaseFieldDefinition) {
381 382 383
        $definition->setProvider($provider);
      }
    }
384

385 386 387 388 389 390 391
    // Retrieve base field definitions from modules.
    foreach ($this->moduleHandler->getImplementations('entity_base_field_info') as $module) {
      $module_definitions = $this->moduleHandler->invoke($module, 'entity_base_field_info', array($entity_type));
      if (!empty($module_definitions)) {
        // Ensure the provider key actually matches the name of the provider
        // defining the field.
        foreach ($module_definitions as $field_name => $definition) {
392 393
          // @todo Remove this check once FieldDefinitionInterface exposes a
          //  proper provider setter. See https://drupal.org/node/2225961.
394
          if ($definition instanceof BaseFieldDefinition && $definition->getProvider() == NULL) {
395 396 397 398 399 400
            $definition->setProvider($module);
          }
          $base_field_definitions[$field_name] = $definition;
        }
      }
    }
401

402 403
    // Automatically set the field name, target entity type and bundle
    // for non-configurable fields.
404
    foreach ($base_field_definitions as $field_name => $base_field_definition) {
405
      if ($base_field_definition instanceof BaseFieldDefinition) {
406 407
        $base_field_definition->setName($field_name);
        $base_field_definition->setTargetEntityTypeId($entity_type_id);
408
        $base_field_definition->setBundle(NULL);
409 410 411 412 413 414
      }
    }

    // Invoke alter hook.
    $this->moduleHandler->alter('entity_base_field_info', $base_field_definitions, $entity_type);

415 416 417 418 419 420 421 422 423
    // Ensure defined entity keys are there and have proper revisionable and
    // translatable values.
    $keys = array_filter($entity_type->getKeys() + array('langcode' => 'langcode'));
    foreach ($keys as $key => $field_name) {
      if (isset($base_field_definitions[$field_name]) && in_array($key, array('id', 'revision', 'uuid', 'bundle')) && $base_field_definitions[$field_name]->isRevisionable()) {
        throw new \LogicException(String::format('The @field field cannot be revisionable as it is used as @key entity key.', array('@field' => $base_field_definitions[$field_name]->getLabel(), '@key' => $key)));
      }
      if (isset($base_field_definitions[$field_name]) && in_array($key, array('id', 'revision', 'uuid', 'bundle', 'langcode')) && $base_field_definitions[$field_name]->isTranslatable()) {
        throw new \LogicException(String::format('The @field field cannot be translatable as it is used as @key entity key.', array('@field' => $base_field_definitions[$field_name]->getLabel(), '@key' => $key)));
424 425
      }
    }
426 427 428 429 430 431 432 433 434 435 436
    return $base_field_definitions;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldDefinitions($entity_type_id, $bundle) {
    if (!isset($this->fieldDefinitions[$entity_type_id][$bundle])) {
      $base_field_definitions = $this->getBaseFieldDefinitions($entity_type_id);
      // Not prepared, try to load from cache.
      $cid = 'entity_bundle_field_definitions:' . $entity_type_id . ':' . $bundle . ':' . $this->languageManager->getCurrentLanguage()->id;
437
      if ($cache = $this->cacheBackend->get($cid)) {
438 439 440 441
        $bundle_field_definitions = $cache->data;
      }
      else {
        // Rebuild the definitions and put it into the cache.
442
        $bundle_field_definitions = $this->buildBundleFieldDefinitions($entity_type_id, $bundle, $base_field_definitions);
443
        $this->cacheBackend->set($cid, $bundle_field_definitions, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
444 445 446 447 448 449
      }
      // Field definitions consist of the bundle specific overrides and the
      // base fields, merge them together. Use array_replace() to replace base
      // fields with by bundle overrides and keep them in order, append
      // additional by bundle fields.
      $this->fieldDefinitions[$entity_type_id][$bundle] = array_replace($base_field_definitions, $bundle_field_definitions);
450
    }
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
    return $this->fieldDefinitions[$entity_type_id][$bundle];
  }

  /**
   * Builds field definitions for a specific bundle within an entity type.
   *
   * @param string $entity_type_id
   *   The entity type ID. Only entity types that implement
   *   \Drupal\Core\Entity\ContentEntityInterface are supported.
   * @param string $bundle
   *   The bundle.
   * @param \Drupal\Core\Field\FieldDefinitionInterface[] $base_field_definitions
   *   The list of base field definitions.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   An array of bundle field definitions, keyed by field name. Does
   *   not include base fields.
   */
469
  protected function buildBundleFieldDefinitions($entity_type_id, $bundle, array $base_field_definitions) {
470 471 472
    $entity_type = $this->getDefinition($entity_type_id);
    $class = $entity_type->getClass();

473 474
    // Allow the entity class to provide bundle fields and bundle-specific
    // overrides of base fields.
475
    $bundle_field_definitions = $class::bundleFieldDefinitions($entity_type, $bundle, $base_field_definitions);
476 477 478 479 480 481 482 483 484 485 486 487 488

    // Load base field overrides from configuration. These take precedence over
    // base field overrides returned above.
    $base_field_override_ids = array_map(function($field_name) use ($entity_type_id, $bundle) {
      return $entity_type_id . '.' . $bundle . '.' . $field_name;
    }, array_keys($base_field_definitions));
    $base_field_overrides = $this->getStorage('base_field_override')->loadMultiple($base_field_override_ids);
    foreach ($base_field_overrides as $base_field_override) {
      /** @var \Drupal\Core\Field\Entity\BaseFieldOverride $base_field_override */
      $field_name = $base_field_override->getName();
      $bundle_field_definitions[$field_name] = $base_field_override;
    }

489 490
    $provider = $entity_type->getProvider();
    foreach ($bundle_field_definitions as $definition) {
491 492
      // @todo Remove this check once FieldDefinitionInterface exposes a proper
      //  provider setter. See https://drupal.org/node/2225961.
493
      if ($definition instanceof BaseFieldDefinition) {
494 495 496
        $definition->setProvider($provider);
      }
    }
497

498 499 500 501 502 503 504
    // Retrieve base field definitions from modules.
    foreach ($this->moduleHandler->getImplementations('entity_bundle_field_info') as $module) {
      $module_definitions = $this->moduleHandler->invoke($module, 'entity_bundle_field_info', array($entity_type, $bundle, $base_field_definitions));
      if (!empty($module_definitions)) {
        // Ensure the provider key actually matches the name of the provider
        // defining the field.
        foreach ($module_definitions as $field_name => $definition) {
505 506
          // @todo Remove this check once FieldDefinitionInterface exposes a
          //  proper provider setter. See https://drupal.org/node/2225961.
507
          if ($definition instanceof BaseFieldDefinition) {
508 509 510 511 512 513
            $definition->setProvider($module);
          }
          $bundle_field_definitions[$field_name] = $definition;
        }
      }
    }
514

515 516
    // Automatically set the field name, target entity type and bundle
    // for non-configurable fields.
517
    foreach ($bundle_field_definitions as $field_name => $field_definition) {
518
      if ($field_definition instanceof BaseFieldDefinition) {
519 520
        $field_definition->setName($field_name);
        $field_definition->setTargetEntityTypeId($entity_type_id);
521
        $field_definition->setBundle($bundle);
522 523
      }
    }
524 525 526 527 528

    // Invoke 'per bundle' alter hook.
    $this->moduleHandler->alter('entity_bundle_field_info', $bundle_field_definitions, $entity_type, $bundle);

    return $bundle_field_definitions;
529 530
  }

531 532 533 534 535 536 537 538 539 540 541 542 543 544
  /**
   * {@inheritdoc}
   */
  public function getFieldStorageDefinitions($entity_type_id) {
    if (!isset($this->fieldStorageDefinitions[$entity_type_id])) {
      $this->fieldStorageDefinitions[$entity_type_id] = array();
      // Add all non-computed base fields.
      foreach ($this->getBaseFieldDefinitions($entity_type_id) as $field_name => $definition) {
        if (!$definition->isComputed()) {
          $this->fieldStorageDefinitions[$entity_type_id][$field_name] = $definition;
        }
      }
      // Not prepared, try to load from cache.
      $cid = 'entity_field_storage_definitions:' . $entity_type_id . ':' . $this->languageManager->getCurrentLanguage()->id;
545
      if ($cache = $this->cacheBackend->get($cid)) {
546 547 548 549 550
        $field_storage_definitions = $cache->data;
      }
      else {
        // Rebuild the definitions and put it into the cache.
        $field_storage_definitions = $this->buildFieldStorageDefinitions($entity_type_id);
551
        $this->cacheBackend->set($cid, $field_storage_definitions, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
552 553 554 555 556 557
      }
      $this->fieldStorageDefinitions[$entity_type_id] += $field_storage_definitions;
    }
    return $this->fieldStorageDefinitions[$entity_type_id];
  }

558 559 560 561 562 563 564
  /**
   * {@inheritdoc}
   */
  public function getFieldMap() {
    if (!$this->fieldMap) {
      // Not prepared, try to load from cache.
      $cid = 'entity_field_map';
565
      if ($cache = $this->cacheBackend->get($cid)) {
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
        $this->fieldMap = $cache->data;
      }
      else {
        // Rebuild the definitions and put it into the cache.
        foreach ($this->getDefinitions() as $entity_type_id => $entity_type) {
          if ($entity_type->isSubclassOf('\Drupal\Core\Entity\ContentEntityInterface')) {
            foreach ($this->getBundleInfo($entity_type_id) as $bundle => $bundle_info) {
              foreach ($this->getFieldDefinitions($entity_type_id, $bundle) as $field_name => $field_definition) {
                $this->fieldMap[$entity_type_id][$field_name]['type'] = $field_definition->getType();
                $this->fieldMap[$entity_type_id][$field_name]['bundles'][] = $bundle;
              }
            }
          }
        }

581
        $this->cacheBackend->set($cid, $this->fieldMap, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
582 583 584 585 586
      }
    }
    return $this->fieldMap;
  }

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
  /**
   * {@inheritdoc}
   */
  public function getFieldMapByFieldType($field_type) {
    if (!isset($this->fieldMapByFieldType[$field_type])) {
      $filtered_map = array();
      $map = $this->getFieldMap();
      foreach ($map as $entity_type => $fields) {
        foreach ($fields as $field_name => $field_info) {
          if ($field_info['type'] == $field_type) {
            $filtered_map[$entity_type][$field_name] = $field_info;
          }
        }
      }
      $this->fieldMapByFieldType[$field_type] = $filtered_map;
    }
    return $this->fieldMapByFieldType[$field_type];
  }

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
  /**
   * Builds field storage definitions for an entity type.
   *
   * @param string $entity_type_id
   *   The entity type ID. Only entity types that implement
   *   \Drupal\Core\Entity\ContentEntityInterface are supported
   *
   * @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
   *   An array of field storage definitions, keyed by field name.
   */
  protected function buildFieldStorageDefinitions($entity_type_id) {
    $entity_type = $this->getDefinition($entity_type_id);
    $field_definitions = array();

    // Retrieve base field definitions from modules.
    foreach ($this->moduleHandler->getImplementations('entity_field_storage_info') as $module) {
      $module_definitions = $this->moduleHandler->invoke($module, 'entity_field_storage_info', array($entity_type));
      if (!empty($module_definitions)) {
        // Ensure the provider key actually matches the name of the provider
        // defining the field.
        foreach ($module_definitions as $field_name => $definition) {
          // @todo Remove this check once FieldDefinitionInterface exposes a
          //  proper provider setter. See https://drupal.org/node/2225961.
629
          if ($definition instanceof BaseFieldDefinition) {
630 631 632 633 634 635 636 637 638 639 640 641 642
            $definition->setProvider($module);
          }
          $field_definitions[$field_name] = $definition;
        }
      }
    }

    // Invoke alter hook.
    $this->moduleHandler->alter('entity_field_storage_info', $field_definitions, $entity_type);

    return $field_definitions;
  }

643
  /**
644
   * {@inheritdoc}
645 646
   */
  public function clearCachedFieldDefinitions() {
647 648
    $this->baseFieldDefinitions = array();
    $this->fieldDefinitions = array();
649
    $this->fieldStorageDefinitions = array();
650
    $this->fieldMap = array();
651
    $this->fieldMapByFieldType = array();
652 653
    $this->displayModeInfo = array();
    $this->extraFields = array();
654
    Cache::deleteTags(array('entity_field_info' => TRUE));
655 656 657 658 659 660 661 662 663 664 665 666 667
    // The typed data manager statically caches prototype objects with injected
    // definitions, clear those as well.
    $this->typedDataManager->clearCachedDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  public function clearCachedBundles() {
    $this->bundleInfo = array();
    Cache::deleteTags(array('entity_bundles' => TRUE));
    // Entity bundles are exposed as data types, clear that cache too.
    $this->typedDataManager->clearCachedDefinitions();
668 669
  }

670
  /**
671
   * {@inheritdoc}
672 673 674 675 676 677 678
   */
  public function getBundleInfo($entity_type) {
    $bundle_info = $this->getAllBundleInfo();
    return isset($bundle_info[$entity_type]) ? $bundle_info[$entity_type] : array();
  }

  /**
679
   * {@inheritdoc}
680 681
   */
  public function getAllBundleInfo() {
682
    if (empty($this->bundleInfo)) {
683
      $langcode = $this->languageManager->getCurrentLanguage()->id;
684
      if ($cache = $this->cacheBackend->get("entity_bundle_info:$langcode")) {
685 686 687 688
        $this->bundleInfo = $cache->data;
      }
      else {
        $this->bundleInfo = $this->moduleHandler->invokeAll('entity_bundle_info');
689 690
        // First look for entity types that act as bundles for others, load them
        // and add them as bundles.
691
        foreach ($this->getDefinitions() as $type => $entity_type) {
692 693 694 695 696 697 698 699
          if ($entity_type->getBundleOf()) {
            foreach ($this->getStorage($type)->loadMultiple() as $entity) {
              $this->bundleInfo[$entity_type->getBundleOf()][$entity->id()]['label'] = $entity->label();
            }
          }
        }
        foreach ($this->getDefinitions() as $type => $entity_type) {
          // If no bundles are provided, use the entity type name and label.
700
          if (!isset($this->bundleInfo[$type])) {
701
            $this->bundleInfo[$type][$type]['label'] = $entity_type->getLabel();
702 703 704
          }
        }
        $this->moduleHandler->alter('entity_bundle_info', $this->bundleInfo);
705
        $this->cacheBackend->set("entity_bundle_info:$langcode", $this->bundleInfo, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_bundles' => TRUE));
706 707 708 709 710 711
      }
    }

    return $this->bundleInfo;
  }

712 713 714 715 716 717 718 719 720 721 722 723 724
  /**
   * {@inheritdoc}
   */
  public function getExtraFields($entity_type_id, $bundle) {
    // Read from the "static" cache.
    if (isset($this->extraFields[$entity_type_id][$bundle])) {
      return $this->extraFields[$entity_type_id][$bundle];
    }

    // Read from the persistent cache. Since hook_entity_extra_field_info() and
    // hook_entity_extra_field_info_alter() might contain t() calls, we cache
    // per language.
    $cache_id = 'entity_bundle_extra_fields:' . $entity_type_id . ':' . $bundle . ':' . $this->languageManager->getCurrentLanguage()->id;
725
    $cached = $this->cacheBackend->get($cache_id);
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
    if ($cached) {
      $this->extraFields[$entity_type_id][$bundle] = $cached->data;
      return $this->extraFields[$entity_type_id][$bundle];
    }

    $extra = $this->moduleHandler->invokeAll('entity_extra_field_info');
    $this->moduleHandler->alter('entity_extra_field_info', $extra);
    $info = isset($extra[$entity_type_id][$bundle]) ? $extra[$entity_type_id][$bundle] : array();
    $info += array(
      'form' => array(),
      'display' => array(),
    );

    // Store in the 'static' and persistent caches.
    $this->extraFields[$entity_type_id][$bundle] = $info;
741
    $this->cacheBackend->set($cache_id, $info, Cache::PERMANENT, array(
742 743 744 745 746 747
      'entity_field_info' => TRUE,
    ));

    return $this->extraFields[$entity_type_id][$bundle];
  }

748
  /**
749
   * {@inheritdoc}
750
   */
751
  public function getEntityTypeLabels($group = FALSE) {
752
    $options = array();
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
    $definitions = $this->getDefinitions();

    foreach ($definitions as $entity_type_id => $definition) {
      if ($group) {
        $options[$definition->getGroupLabel()][$entity_type_id] = $definition->getLabel();
      }
      else {
        $options[$entity_type_id] = $definition->getLabel();
      }
    }

    if ($group) {
      foreach ($options as &$group_options) {
        // Sort the list alphabetically by group label.
        array_multisort($group_options, SORT_ASC, SORT_NATURAL);
      }

      // Make sure that the 'Content' group is situated at the top.
      $content = $this->t('Content', array(), array('context' => 'Entity type group'));
      $options = array($content => $options[$content]) + $options;
773 774 775 776 777
    }

    return $options;
  }

778 779 780 781 782 783 784 785
  /**
   * {@inheritdoc}
   */
  public function getTranslationFromContext(EntityInterface $entity, $langcode = NULL, $context = array()) {
    $translation = $entity;

    if ($entity instanceof TranslatableInterface) {
      if (empty($langcode)) {
786
        $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->id;
787 788 789 790 791
      }

      // Retrieve language fallback candidates to perform the entity language
      // negotiation.
      $context['data'] = $entity;
792 793
      $context += array('operation' => 'entity_view', 'langcode' => $langcode);
      $candidates = $this->languageManager->getFallbackCandidates($context);
794 795 796

      // Ensure the default language has the proper language code.
      $default_language = $entity->getUntranslated()->language();
797
      $candidates[$default_language->id] = LanguageInterface::LANGCODE_DEFAULT;
798 799 800 801 802 803 804 805 806 807 808 809 810

      // Return the most fitting entity translation.
      foreach ($candidates as $candidate) {
        if ($entity->hasTranslation($candidate)) {
          $translation = $entity->getTranslation($candidate);
          break;
        }
      }
    }

    return $translation;
  }

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
  /**
   * {@inheritdoc}
   */
  public function getAllViewModes() {
    return $this->getAllDisplayModesByEntityType('view_mode');
  }

  /**
   * {@inheritdoc}
   */
  public function getViewModes($entity_type_id) {
    return $this->getDisplayModesByEntityType('view_mode', $entity_type_id);
  }

  /**
   * {@inheritdoc}
   */
  public function getAllFormModes() {
    return $this->getAllDisplayModesByEntityType('form_mode');
  }

  /**
   * {@inheritdoc}
   */
  public function getFormModes($entity_type_id) {
    return $this->getDisplayModesByEntityType('form_mode', $entity_type_id);
  }

  /**
   * Returns the entity display mode info for all entity types.
   *
   * @param string $display_type
   *   The display type to be retrieved. It can be "view_mode" or "form_mode".
   *
   * @return array
   *   The display mode info for all entity types.
   */
  protected function getAllDisplayModesByEntityType($display_type) {
    if (!isset($this->displayModeInfo[$display_type])) {
      $key = 'entity_' . $display_type . '_info';
851
      $entity_type_id = 'entity_' . $display_type;
852
      $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_INTERFACE)->id;
853
      if ($cache = $this->cacheBackend->get("$key:$langcode")) {
854 855 856 857
        $this->displayModeInfo[$display_type] = $cache->data;
      }
      else {
        $this->displayModeInfo[$display_type] = array();
858
        foreach ($this->getStorage($entity_type_id)->loadMultiple() as $display_mode) {
859
          list($display_mode_entity_type, $display_mode_name) = explode('.', $display_mode->id(), 2);
860
          $this->displayModeInfo[$display_type][$display_mode_entity_type][$display_mode_name] = $display_mode->toArray();
861 862
        }
        $this->moduleHandler->alter($key, $this->displayModeInfo[$display_type]);
863
        $this->cacheBackend->set("$key:$langcode", $this->displayModeInfo[$display_type], CacheBackendInterface::CACHE_PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
      }
    }

    return $this->displayModeInfo[$display_type];
  }

  /**
   * Returns the entity display mode info for a specific entity type.
   *
   * @param string $display_type
   *   The display type to be retrieved. It can be "view_mode" or "form_mode".
   * @param string $entity_type_id
   *   The entity type whose display mode info should be returned.
   *
   * @return array
   *   The display mode info for a specific entity type.
   */
  protected function getDisplayModesByEntityType($display_type, $entity_type_id) {
    if (isset($this->displayModeInfo[$display_type][$entity_type_id])) {
      return $this->displayModeInfo[$display_type][$entity_type_id];
    }
    else {
      $display_modes = $this->getAllDisplayModesByEntityType($display_type);
      if (isset($display_modes[$entity_type_id])) {
        return $display_modes[$entity_type_id];
      }
    }
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public function getViewModeOptions($entity_type, $include_disabled = FALSE) {
    return $this->getDisplayModeOptions('view_mode', $entity_type, $include_disabled);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormModeOptions($entity_type, $include_disabled = FALSE) {
    return $this->getDisplayModeOptions('form_mode', $entity_type, $include_disabled);
  }

  /**
   * Returns an array of display mode options.
   *
   * @param string $display_type
   *   The display type to be retrieved. It can be "view_mode" or "form_mode".
   * @param string $entity_type_id
   *   The entity type whose display mode options should be returned.
   * @param bool $include_disabled
   *   Force to include disabled display modes. Defaults to FALSE.
   *
   * @return array
   *   An array of display mode labels, keyed by the display mode ID.
   */
  protected function getDisplayModeOptions($display_type, $entity_type_id, $include_disabled = FALSE) {
    $options = array('default' => t('Default'));
    foreach ($this->getDisplayModesByEntityType($display_type, $entity_type_id) as $mode => $settings) {
      if (!empty($settings['status']) || $include_disabled) {
        $options[$mode] = $settings['label'];
      }
    }
    return $options;
  }

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
  /**
   * {@inheritdoc}
   */
  public function loadEntityByUuid($entity_type_id, $uuid) {
    $entity_type = $this->getDefinition($entity_type_id);

    if (!$uuid_key = $entity_type->getKey('uuid')) {
      throw new EntityStorageException("Entity type $entity_type_id does not support UUIDs.");
    }

    $entities = $this->getStorage($entity_type_id)->loadByProperties(array($uuid_key => $uuid));

    return reset($entities);
  }

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
  /**
   * {@inheritdoc}
   */
  public function getEntityTypeFromClass($class_name) {

    // Check the already calculated classes first.
    if (isset($this->classNameEntityTypeMap[$class_name])) {
      return $this->classNameEntityTypeMap[$class_name];
    }

    $same_class = 0;
    $entity_type_id = NULL;
    foreach ($this->getDefinitions() as $entity_type) {
      if ($entity_type->getOriginalClass() == $class_name  || $entity_type->getClass() == $class_name) {
        $entity_type_id = $entity_type->id();
        if ($same_class++) {
          throw new AmbiguousEntityClassException($class_name);
        }
      }
    }

    // Return the matching entity type ID if there is one.
    if ($entity_type_id) {
      $this->classNameEntityTypeMap[$class_name] = $entity_type_id;
      return $entity_type_id;
    }

    throw new NoCorrespondingEntityClassException($class_name);
  }

976 977 978 979
  /**
   * {@inheritdoc}
   */
  public function onEntityTypeCreate(EntityTypeInterface $entity_type) {
980 981
    $entity_type_id = $entity_type->id();

982 983
    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
984
    $storage = $this->getStorage($entity_type_id);
985 986 987
    if ($storage instanceof EntityTypeListenerInterface) {
      $storage->onEntityTypeCreate($entity_type);
    }
988 989 990 991 992

    $this->setLastInstalledDefinition($entity_type);
    if ($entity_type->isFieldable()) {
      $this->setLastInstalledFieldStorageDefinitions($entity_type_id, $this->getFieldStorageDefinitions($entity_type_id));
    }
993 994 995 996 997 998
  }

  /**
   * {@inheritdoc}
   */
  public function onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original) {
999 1000
    $entity_type_id = $entity_type->id();

1001 1002
    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
1003
    $storage = $this->getStorage($entity_type_id);
1004 1005 1006
    if ($storage instanceof EntityTypeListenerInterface) {
      $storage->onEntityTypeUpdate($entity_type, $original);
    }
1007 1008

    $this->setLastInstalledDefinition($entity_type);
1009 1010 1011 1012 1013 1014
  }

  /**
   * {@inheritdoc}
   */
  public function onEntityTypeDelete(EntityTypeInterface $entity_type) {
1015 1016
    $entity_type_id = $entity_type->id();

1017 1018
    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
1019
    $storage = $this->getStorage($entity_type_id);
1020 1021 1022
    if ($storage instanceof EntityTypeListenerInterface) {
      $storage->onEntityTypeDelete($entity_type);
    }
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

    $this->deleteLastInstalledDefinition($entity_type_id);
  }

  /**
   * {@inheritdoc}
   */
  public function onFieldStorageDefinitionCreate(FieldStorageDefinitionInterface $storage_definition) {
    $entity_type_id = $storage_definition->getTargetEntityTypeId();

    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
    $storage = $this->getStorage($entity_type_id);
    if ($storage instanceof FieldStorageDefinitionListenerInterface) {
      $storage->onFieldStorageDefinitionCreate($storage_definition);
    }

    $this->setLastInstalledFieldStorageDefinition($storage_definition);
    $this->clearCachedFieldDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  public function onFieldStorageDefinitionUpdate(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) {
    $entity_type_id = $storage_definition->getTargetEntityTypeId();

    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
    $storage = $this->getStorage($entity_type_id);
    if ($storage instanceof FieldStorageDefinitionListenerInterface) {
      $storage->onFieldStorageDefinitionUpdate($storage_definition, $original);
    }

    $this->setLastInstalledFieldStorageDefinition($storage_definition);
    $this->clearCachedFieldDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  public function onFieldStorageDefinitionDelete(FieldStorageDefinitionInterface $storage_definition) {
    $entity_type_id = $storage_definition->getTargetEntityTypeId();

    // @todo Forward this to all interested handlers, not only storage, once
    //   iterating handlers is possible: https://www.drupal.org/node/2332857.
    $storage = $this->getStorage($entity_type_id);
    if ($storage instanceof FieldStorageDefinitionListenerInterface) {
      $storage->onFieldStorageDefinitionDelete($storage_definition);
    }

    $this->deleteLastInstalledFieldStorageDefinition($storage_definition);
    $this->clearCachedFieldDefinitions();
1076 1077
  }

1078
  /**
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
   * {@inheritdoc}
   */
  public function onBundleCreate($entity_type_id, $bundle) {
    $this->clearCachedBundles();
    // Notify the entity storage.
    $storage = $this->getStorage($entity_type_id);
    if ($storage instanceof FieldableEntityStorageInterface) {
      $storage->onBundleCreate($bundle);
    }
    // Invoke hook_entity_bundle_create() hook.
    $this->moduleHandler->invokeAll('entity_bundle_create', array($entity_type_id, $bundle));
  }

  /**
   * {@inheritdoc}
1094 1095
   */
  public function onBundleRename($entity_type_id, $bundle_old, $bundle_new) {
1096 1097 1098 1099 1100 1101 1102
    $this->clearCachedBundles();
    // Notify the entity storage.
    $storage = $this->getStorage($entity_type_id);
    if ($storage instanceof FieldableEntityStorageInterface) {
      $storage->onBundleRename($bundle_old, $bundle_new);
    }

1103 1104 1105 1106 1107 1108 1109 1110
    // Rename existing base field bundle overrides.
    $overrides = $this->getStorage('base_field_override')->loadByProperties(array('entity_type' => $entity_type_id, 'bundle' => $bundle_old));
    foreach ($overrides as $override) {
      $override->set('id', $entity_type_id . '.' . $bundle_new . '.' . $override->field_name);
      $override->bundle = $bundle_new;
      $override->allowBundleRename();
      $override->save();
    }
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129

    // Invoke hook_entity_bundle_rename() hook.
    $this->moduleHandler->invokeAll('entity_bundle_rename', array($entity_type_id, $bundle_old, $bundle_new));
    $this->clearCachedFieldDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  public function onBundleDelete($entity_type_id, $bundle) {
    $this->clearCachedBundles();
    // Notify the entity storage.
    $storage = $this->getStorage($entity_type_id);
    if ($storage instanceof Fieldab