EntityManager.php 33.8 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\FieldDefinition;
15
use Drupal\Core\Cache\Cache;
16
use Drupal\Core\Cache\CacheBackendInterface;
17
use Drupal\Core\Extension\ModuleHandlerInterface;
18
use Drupal\Core\Language\LanguageManagerInterface;
19
use Drupal\Core\Language\LanguageInterface;
20
use Drupal\Core\Plugin\DefaultPluginManager;
21
use Drupal\Core\StringTranslation\StringTranslationTrait;
22
use Drupal\Core\StringTranslation\TranslationInterface;
23
use Drupal\Core\TypedData\TranslatableInterface;
24
use Drupal\Core\TypedData\TypedDataManager;
25 26
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
27 28 29 30

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

  use ContainerAwareTrait;
45
  use StringTranslationTrait;
46

47 48 49 50 51 52 53
  /**
   * Extra fields by bundle.
   *
   * @var array
   */
  protected $extraFields = array();

54 55 56 57 58 59 60
  /**
   * Contains instantiated controllers keyed by controller type and entity type.
   *
   * @var array
   */
  protected $controllers = array();

61
  /**
62
   * Static cache of base field definitions.
63 64 65
   *
   * @var array
   */
66
  protected $baseFieldDefinitions;
67 68 69 70 71 72 73 74

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

75 76 77 78 79 80 81 82 83 84
  /**
   * Static cache of field storage definitions per entity type.
   *
   * Elements of the array:
   *  - $entity_type_id: \Drupal\Core\Field\FieldDefinition[]
   *
   * @var array
   */
  protected $fieldStorageDefinitions;

85 86 87 88 89 90 91
  /**
   * The string translationManager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $translationManager;

92 93 94 95 96 97 98
  /**
   * The class resolver.
   *
   * @var \Drupal\Core\DependencyInjection\ClassResolverInterface
   */
  protected $classResolver;

99 100 101 102 103 104 105
  /**
   * The typed data manager.
   *
   * @var \Drupal\Core\TypedData\TypedDataManager
   */
  protected $typedDataManager;

106 107 108 109 110 111 112
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

113
  /**
114 115 116 117 118 119
   * Static cache of bundle information.
   *
   * @var array
   */
  protected $bundleInfo;

120 121 122 123 124 125 126
  /**
   * Static cache of display modes information.
   *
   * @var array
   */
  protected $displayModeInfo = array();

127 128 129 130 131 132 133 134 135 136
  /**
   * 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();

137 138 139 140 141 142 143 144 145 146
  /**
   * 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();

147 148
  /**
   * Constructs a new Entity plugin manager.
149
   *
150 151 152
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations,
153 154 155 156
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache backend to use.
157
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
158
   *   The language manager.
159 160
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translation_manager
   *   The string translationManager.
161 162
   * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
   *   The class resolver.
163
   */
164
  public function __construct(\Traversable $namespaces, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache, LanguageManagerInterface $language_manager, TranslationInterface $translation_manager, ClassResolverInterface $class_resolver, TypedDataManager $typed_data_manager) {
165
    parent::__construct('Entity', $namespaces, $module_handler, 'Drupal\Core\Entity\Annotation\EntityType');
166

167
    $this->setCacheBackend($cache, 'entity_type', array('entity_types' => TRUE));
168
    $this->alterInfo('entity_type');
169

170
    $this->languageManager = $language_manager;
171
    $this->translationManager = $translation_manager;
172
    $this->classResolver = $class_resolver;
173
    $this->typedDataManager = $typed_data_manager;
174 175
  }

176 177 178 179 180
  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions() {
    parent::clearCachedDefinitions();
181 182
    $this->clearCachedBundles();
    $this->clearCachedFieldDefinitions();
183 184
  }

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  /**
   * {@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;
  }

206
  /**
207
   * {@inheritdoc}
208
   */
209 210
  public function getDefinition($entity_type_id, $exception_on_invalid = TRUE) {
    if (($entity_type = parent::getDefinition($entity_type_id, FALSE)) && class_exists($entity_type->getClass())) {
211
      return $entity_type;
212
    }
213 214 215 216
    elseif (!$exception_on_invalid) {
      return NULL;
    }

217
    throw new PluginNotFoundException($entity_type_id, sprintf('The "%s" entity type does not exist.', $entity_type_id));
218 219
  }

220
  /**
221
   * {@inheritdoc}
222
   */
223
  public function hasController($entity_type, $controller_type) {
224
    if ($definition = $this->getDefinition($entity_type, FALSE)) {
225
      return $definition->hasControllerClass($controller_type);
226
    }
227
    return FALSE;
228 229 230
  }

  /**
231
   * {@inheritdoc}
232
   */
233
  public function getStorage($entity_type) {
234
    return $this->getController($entity_type, 'storage', 'getStorageClass');
235 236 237
  }

  /**
238
   * {@inheritdoc}
239
   */
240 241
  public function getListBuilder($entity_type) {
    return $this->getController($entity_type, 'list_builder', 'getListBuilderClass');
242 243 244
  }

  /**
245
   * {@inheritdoc}
246
   */
247
  public function getFormObject($entity_type, $operation) {
248
    if (!isset($this->controllers['form'][$operation][$entity_type])) {
249 250 251
      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));
      }
252 253

      $controller = $this->classResolver->getInstanceFromDefinition($class);
254 255

      $controller
256
        ->setStringTranslation($this->translationManager)
257 258 259
        ->setModuleHandler($this->moduleHandler)
        ->setOperation($operation);
      $this->controllers['form'][$operation][$entity_type] = $controller;
260 261 262 263 264
    }
    return $this->controllers['form'][$operation][$entity_type];
  }

  /**
265
   * {@inheritdoc}
266
   */
267
  public function getViewBuilder($entity_type) {
268
    return $this->getController($entity_type, 'view_builder', 'getViewBuilderClass');
269 270 271
  }

  /**
272
   * {@inheritdoc}
273 274
   */
  public function getAccessController($entity_type) {
275
    return $this->getController($entity_type, 'access', 'getAccessClass');
276 277 278 279 280 281
  }

  /**
   * Creates a new controller instance.
   *
   * @param string $entity_type
282
   *   The entity type for this controller.
283 284
   * @param string $controller_type
   *   The controller type to create an instance for.
285 286
   * @param string $controller_class_getter
   *   (optional) The method to call on the entity type object to get the controller class.
287
   *
288
   * @return mixed
289
   *   A controller instance.
290 291
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
292
   */
293
  public function getController($entity_type, $controller_type, $controller_class_getter = NULL) {
294
    if (!isset($this->controllers[$controller_type][$entity_type])) {
295
      $definition = $this->getDefinition($entity_type);
296 297
      if ($controller_class_getter) {
        $class = $definition->{$controller_class_getter}();
298 299
      }
      else {
300 301 302 303 304 305 306 307 308 309 310 311 312 313
        $class = $definition->getControllerClass($controller_type);
      }
      if (!$class) {
        throw new InvalidPluginDefinitionException($entity_type, sprintf('The "%s" entity type did not specify a %s class.', $entity_type, $controller_type));
      }
      if (is_subclass_of($class, 'Drupal\Core\Entity\EntityControllerInterface')) {
        $controller = $class::createInstance($this->container, $definition);
      }
      else {
        $controller = new $class($definition);
      }
      if (method_exists($controller, 'setModuleHandler')) {
        $controller->setModuleHandler($this->moduleHandler);
      }
314 315
      if (method_exists($controller, 'setStringTranslation')) {
        $controller->setStringTranslation($this->translationManager);
316
      }
317
      $this->controllers[$controller_type][$entity_type] = $controller;
318
    }
319
    return $this->controllers[$controller_type][$entity_type];
320 321
  }

322
  /**
323
   * {@inheritdoc}
324
   */
325
  public function getAdminRouteInfo($entity_type_id, $bundle) {
326
    if (($entity_type = $this->getDefinition($entity_type_id, FALSE)) && $admin_form = $entity_type->getLinkTemplate('admin-form')) {
327 328 329
      return array(
        'route_name' => $admin_form,
        'route_parameters' => array(
330
          $entity_type->getBundleEntityType() => $bundle,
331 332
        ),
      );
333
    }
334 335
  }

336
  /**
337
   * {@inheritdoc}
338
   */
339 340 341 342 343
  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;
344
      if ($cache = $this->cacheBackend->get($cid)) {
345
        $this->baseFieldDefinitions[$entity_type_id] = $cache->data;
346 347
      }
      else {
348 349
        // Rebuild the definitions and put it into the cache.
        $this->baseFieldDefinitions[$entity_type_id] = $this->buildBaseFieldDefinitions($entity_type_id);
350
        $this->cacheBackend->set($cid, $this->baseFieldDefinitions[$entity_type_id], Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
351 352 353 354 355 356 357 358 359 360
       }
     }
    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
361
   *   \Drupal\Core\Entity\ContentEntityInterface are supported.
362 363 364 365 366
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   An array of field definitions, keyed by field name.
   *
   * @throws \LogicException
367 368
   *   Thrown if a config entity type is given or if one of the entity keys is
   *   flagged as translatable.
369 370 371 372 373
   */
  protected function buildBaseFieldDefinitions($entity_type_id) {
    $entity_type = $this->getDefinition($entity_type_id);
    $class = $entity_type->getClass();

374 375 376 377 378
    // 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())));
    }

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

390 391 392 393 394 395 396
    // 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) {
397 398
          // @todo Remove this check once FieldDefinitionInterface exposes a
          //  proper provider setter. See https://drupal.org/node/2225961.
399
          if ($definition instanceof FieldDefinition && $definition->getProvider() == NULL) {
400 401 402 403 404 405
            $definition->setProvider($module);
          }
          $base_field_definitions[$field_name] = $definition;
        }
      }
    }
406

407 408
    // Automatically set the field name, target entity type and bundle
    // for non-configurable fields.
409 410 411 412
    foreach ($base_field_definitions as $field_name => $base_field_definition) {
      if ($base_field_definition instanceof FieldDefinition) {
        $base_field_definition->setName($field_name);
        $base_field_definition->setTargetEntityTypeId($entity_type_id);
413
        $base_field_definition->setBundle(NULL);
414 415 416 417 418 419
      }
    }

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

420 421 422 423 424 425 426 427 428
    // 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)));
429 430
      }
    }
431 432 433 434 435 436 437 438 439 440 441
    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;
442
      if ($cache = $this->cacheBackend->get($cid)) {
443 444 445 446
        $bundle_field_definitions = $cache->data;
      }
      else {
        // Rebuild the definitions and put it into the cache.
447
        $bundle_field_definitions = $this->buildBundleFieldDefinitions($entity_type_id, $bundle, $base_field_definitions);
448
        $this->cacheBackend->set($cid, $bundle_field_definitions, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
449 450 451 452 453 454
      }
      // 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);
455
    }
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
    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.
   */
474
  protected function buildBundleFieldDefinitions($entity_type_id, $bundle, array $base_field_definitions) {
475 476 477 478 479
    $entity_type = $this->getDefinition($entity_type_id);
    $class = $entity_type->getClass();

    // Allow the entity class to override the base fields.
    $bundle_field_definitions = $class::bundleFieldDefinitions($entity_type, $bundle, $base_field_definitions);
480 481
    $provider = $entity_type->getProvider();
    foreach ($bundle_field_definitions as $definition) {
482 483
      // @todo Remove this check once FieldDefinitionInterface exposes a proper
      //  provider setter. See https://drupal.org/node/2225961.
484 485 486 487
      if ($definition instanceof FieldDefinition) {
        $definition->setProvider($provider);
      }
    }
488

489 490 491 492 493 494 495
    // 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) {
496 497
          // @todo Remove this check once FieldDefinitionInterface exposes a
          //  proper provider setter. See https://drupal.org/node/2225961.
498 499 500 501 502 503 504
          if ($definition instanceof FieldDefinition) {
            $definition->setProvider($module);
          }
          $bundle_field_definitions[$field_name] = $definition;
        }
      }
    }
505

506 507
    // Automatically set the field name, target entity type and bundle
    // for non-configurable fields.
508 509 510 511
    foreach ($bundle_field_definitions as $field_name => $field_definition) {
      if ($field_definition instanceof FieldDefinition) {
        $field_definition->setName($field_name);
        $field_definition->setTargetEntityTypeId($entity_type_id);
512
        $field_definition->setBundle($bundle);
513 514
      }
    }
515 516 517 518 519

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

    return $bundle_field_definitions;
520 521
  }

522 523 524 525 526 527 528 529 530 531 532 533 534 535
  /**
   * {@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;
536
      if ($cache = $this->cacheBackend->get($cid)) {
537 538 539 540 541
        $field_storage_definitions = $cache->data;
      }
      else {
        // Rebuild the definitions and put it into the cache.
        $field_storage_definitions = $this->buildFieldStorageDefinitions($entity_type_id);
542
        $this->cacheBackend->set($cid, $field_storage_definitions, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
543 544 545 546 547 548
      }
      $this->fieldStorageDefinitions[$entity_type_id] += $field_storage_definitions;
    }
    return $this->fieldStorageDefinitions[$entity_type_id];
  }

549 550 551 552 553 554 555
  /**
   * {@inheritdoc}
   */
  public function getFieldMap() {
    if (!$this->fieldMap) {
      // Not prepared, try to load from cache.
      $cid = 'entity_field_map';
556
      if ($cache = $this->cacheBackend->get($cid)) {
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
        $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;
              }
            }
          }
        }

572
        $this->cacheBackend->set($cid, $this->fieldMap, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
573 574 575 576 577
      }
    }
    return $this->fieldMap;
  }

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
  /**
   * {@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];
  }

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
  /**
   * 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.
          if ($definition instanceof FieldDefinition) {
            $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;
  }

634
  /**
635
   * {@inheritdoc}
636 637
   */
  public function clearCachedFieldDefinitions() {
638 639
    $this->baseFieldDefinitions = array();
    $this->fieldDefinitions = array();
640
    $this->fieldStorageDefinitions = array();
641
    $this->fieldMap = array();
642
    $this->fieldMapByFieldType = array();
643 644
    $this->displayModeInfo = array();
    $this->extraFields = array();
645
    Cache::deleteTags(array('entity_field_info' => TRUE));
646 647 648 649 650 651 652 653 654 655 656 657 658
    // 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();
659 660
  }

661
  /**
662
   * {@inheritdoc}
663 664 665 666 667 668 669
   */
  public function getBundleInfo($entity_type) {
    $bundle_info = $this->getAllBundleInfo();
    return isset($bundle_info[$entity_type]) ? $bundle_info[$entity_type] : array();
  }

  /**
670
   * {@inheritdoc}
671 672
   */
  public function getAllBundleInfo() {
673
    if (empty($this->bundleInfo)) {
674
      $langcode = $this->languageManager->getCurrentLanguage()->id;
675
      if ($cache = $this->cacheBackend->get("entity_bundle_info:$langcode")) {
676 677 678 679
        $this->bundleInfo = $cache->data;
      }
      else {
        $this->bundleInfo = $this->moduleHandler->invokeAll('entity_bundle_info');
680 681
        // First look for entity types that act as bundles for others, load them
        // and add them as bundles.
682
        foreach ($this->getDefinitions() as $type => $entity_type) {
683 684 685 686 687 688 689 690
          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.
691
          if (!isset($this->bundleInfo[$type])) {
692
            $this->bundleInfo[$type][$type]['label'] = $entity_type->getLabel();
693 694 695
          }
        }
        $this->moduleHandler->alter('entity_bundle_info', $this->bundleInfo);
696
        $this->cacheBackend->set("entity_bundle_info:$langcode", $this->bundleInfo, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_bundles' => TRUE));
697 698 699 700 701 702
      }
    }

    return $this->bundleInfo;
  }

703 704 705 706 707 708 709 710 711 712 713 714 715
  /**
   * {@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;
716
    $cached = $this->cacheBackend->get($cache_id);
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
    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;
732
    $this->cacheBackend->set($cache_id, $info, Cache::PERMANENT, array(
733 734 735 736 737 738
      'entity_field_info' => TRUE,
    ));

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

739
  /**
740
   * {@inheritdoc}
741
   */
742
  public function getEntityTypeLabels($group = FALSE) {
743
    $options = array();
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
    $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;
764 765 766 767 768
    }

    return $options;
  }

769 770 771 772 773 774 775 776
  /**
   * {@inheritdoc}
   */
  public function getTranslationFromContext(EntityInterface $entity, $langcode = NULL, $context = array()) {
    $translation = $entity;

    if ($entity instanceof TranslatableInterface) {
      if (empty($langcode)) {
777
        $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->id;
778 779 780 781 782 783 784 785 786 787
      }

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

      // Ensure the default language has the proper language code.
      $default_language = $entity->getUntranslated()->language();
788
      $candidates[$default_language->id] = LanguageInterface::LANGCODE_DEFAULT;
789 790 791 792 793 794 795 796 797 798 799 800 801

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

    return $translation;
  }

802 803 804 805 806 807 808 809 810 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
  /**
   * {@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';
842
      $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_INTERFACE)->id;
843
      if ($cache = $this->cacheBackend->get("$key:$langcode")) {
844 845 846 847
        $this->displayModeInfo[$display_type] = $cache->data;
      }
      else {
        $this->displayModeInfo[$display_type] = array();
848
        foreach ($this->getStorage($display_type)->loadMultiple() as $display_mode) {
849
          list($display_mode_entity_type, $display_mode_name) = explode('.', $display_mode->id(), 2);
850
          $this->displayModeInfo[$display_type][$display_mode_entity_type][$display_mode_name] = $display_mode->toArray();
851 852
        }
        $this->moduleHandler->alter($key, $this->displayModeInfo[$display_type]);
853
        $this->cacheBackend->set("$key:$langcode", $this->displayModeInfo[$display_type], CacheBackendInterface::CACHE_PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
854 855 856 857 858 859 860 861 862 863 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
      }
    }

    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;
  }

921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
  /**
   * {@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);
  }

936
}