EntityManager.php 17.7 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\Plugin\PluginManagerBase;
13
use Drupal\Component\Utility\NestedArray;
14
use Drupal\Component\Utility\String;
15
use Drupal\Core\Field\FieldDefinition;
16
use Drupal\Core\Cache\Cache;
17
use Drupal\Core\Cache\CacheBackendInterface;
18 19
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Language\LanguageManager;
20
use Drupal\Core\Language\Language;
21
use Drupal\Core\Plugin\Discovery\AlterDecorator;
22
use Drupal\Core\Plugin\Discovery\CacheDecorator;
23
use Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery;
24
use Drupal\Core\Plugin\Discovery\InfoHookDecorator;
25
use Drupal\Core\StringTranslation\TranslationInterface;
26
use Drupal\Core\TypedData\TranslatableInterface;
27
use Symfony\Component\DependencyInjection\ContainerInterface;
28 29 30 31

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

45 46 47 48 49 50 51
  /**
   * The injection container that should be passed into the controller factory.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

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

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The cache backend to use.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManager
   */
  protected $languageManager;

  /**
81
   * Static cache of base field definitions.
82 83 84
   *
   * @var array
   */
85
  protected $baseFieldDefinitions;
86 87 88 89 90 91 92 93

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

94 95 96
  /**
   * The root paths.
   *
97
   * @see self::__construct().
98 99 100 101 102
   *
   * @var \Traversable
   */
  protected $namespaces;

103 104 105 106 107 108 109
  /**
   * The string translationManager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $translationManager;

110
  /**
111 112 113 114 115 116
   * Static cache of bundle information.
   *
   * @var array
   */
  protected $bundleInfo;

117 118
  /**
   * Constructs a new Entity plugin manager.
119
   *
120 121 122
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations,
123 124
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The service container this object should use.
125 126 127 128 129 130
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache backend to use.
   * @param \Drupal\Core\Language\LanguageManager $language_manager
   *   The language manager.
131 132
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translation_manager
   *   The string translationManager.
133
   */
134
  public function __construct(\Traversable $namespaces, ContainerInterface $container, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache, LanguageManager $language_manager, TranslationInterface $translation_manager) {
135
    // Allow the plugin definition to be altered by hook_entity_type_alter().
136 137 138 139

    $this->moduleHandler = $module_handler;
    $this->cache = $cache;
    $this->languageManager = $language_manager;
140
    $this->namespaces = $namespaces;
141
    $this->translationManager = $translation_manager;
142

143
    $this->discovery = new AnnotatedClassDiscovery('Entity', $namespaces, 'Drupal\Core\Entity\Annotation\EntityType');
144 145 146
    $this->discovery = new InfoHookDecorator($this->discovery, 'entity_type_build');
    $this->discovery = new AlterDecorator($this->discovery, 'entity_type');
    $this->discovery = new CacheDecorator($this->discovery, 'entity_type:' . $this->languageManager->getCurrentLanguage()->id, 'cache', Cache::PERMANENT, array('entity_types' => TRUE));
147

148
    $this->container = $container;
149 150
  }

151 152 153 154 155 156 157 158 159
  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions() {
    parent::clearCachedDefinitions();

    $this->bundleInfo = NULL;
  }

160
  /**
161
   * {@inheritdoc}
162
   */
163 164 165
  public function getDefinition($entity_type_id, $exception_on_invalid = FALSE) {
    if (($entity_type = parent::getDefinition($entity_type_id)) && class_exists($entity_type->getClass())) {
      return $entity_type;
166
    }
167 168 169 170
    elseif (!$exception_on_invalid) {
      return NULL;
    }

171
    throw new PluginNotFoundException($entity_type_id, sprintf('The "%s" entity type does not exist.', $entity_type_id));
172 173
  }

174
  /**
175
   * {@inheritdoc}
176
   */
177 178 179
  public function hasController($entity_type, $controller_type) {
    if ($definition = $this->getDefinition($entity_type)) {
      return $definition->hasControllerClass($controller_type);
180
    }
181
    return FALSE;
182 183 184
  }

  /**
185
   * {@inheritdoc}
186 187
   */
  public function getStorageController($entity_type) {
188
    return $this->getController($entity_type, 'storage', 'getStorageClass');
189 190 191
  }

  /**
192
   * {@inheritdoc}
193 194
   */
  public function getListController($entity_type) {
195
    return $this->getController($entity_type, 'list', 'getListClass');
196 197 198
  }

  /**
199
   * {@inheritdoc}
200 201 202
   */
  public function getFormController($entity_type, $operation) {
    if (!isset($this->controllers['form'][$operation][$entity_type])) {
203 204 205
      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));
      }
206
      if (in_array('Drupal\Core\DependencyInjection\ContainerInjectionInterface', class_implements($class))) {
207
        $controller = $class::create($this->container);
208 209
      }
      else {
210
        $controller = new $class();
211
      }
212 213 214 215 216 217

      $controller
        ->setTranslationManager($this->translationManager)
        ->setModuleHandler($this->moduleHandler)
        ->setOperation($operation);
      $this->controllers['form'][$operation][$entity_type] = $controller;
218 219 220 221 222
    }
    return $this->controllers['form'][$operation][$entity_type];
  }

  /**
223
   * {@inheritdoc}
224
   */
225
  public function getViewBuilder($entity_type) {
226
    return $this->getController($entity_type, 'view_builder', 'getViewBuilderClass');
227 228 229
  }

  /**
230
   * {@inheritdoc}
231 232
   */
  public function getAccessController($entity_type) {
233
    return $this->getController($entity_type, 'access', 'getAccessClass');
234 235 236 237 238 239
  }

  /**
   * Creates a new controller instance.
   *
   * @param string $entity_type
240
   *   The entity type for this controller.
241 242
   * @param string $controller_type
   *   The controller type to create an instance for.
243 244
   * @param string $controller_class_getter
   *   (optional) The method to call on the entity type object to get the controller class.
245
   *
246
   * @return mixed
247
   *   A controller instance.
248 249
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
250
   */
251
  public function getController($entity_type, $controller_type, $controller_class_getter = NULL) {
252
    if (!isset($this->controllers[$controller_type][$entity_type])) {
253 254 255
      $definition = $this->getDefinition($entity_type, TRUE);
      if ($controller_class_getter) {
        $class = $definition->{$controller_class_getter}();
256 257
      }
      else {
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
        $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);
      }
      if (method_exists($controller, 'setTranslationManager')) {
        $controller->setTranslationManager($this->translationManager);
274
      }
275
      $this->controllers[$controller_type][$entity_type] = $controller;
276
    }
277
    return $this->controllers[$controller_type][$entity_type];
278 279
  }

280
  /**
281
   * {@inheritdoc}
282
   */
283 284
  public function getAdminRouteInfo($entity_type_id, $bundle) {
    if (($entity_type = $this->getDefinition($entity_type_id)) && $admin_form = $entity_type->getLinkTemplate('admin-form')) {
285 286 287
      return array(
        'route_name' => $admin_form,
        'route_parameters' => array(
288
          $entity_type->getBundleEntityType() => $bundle,
289 290
        ),
      );
291
    }
292 293
  }

294
  /**
295
   * {@inheritdoc}
296
   */
297 298 299 300 301
  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;
302
      if ($cache = $this->cache->get($cid)) {
303
        $this->baseFieldDefinitions[$entity_type_id] = $cache->data;
304 305
      }
      else {
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
        // Rebuild the definitions and put it into the cache.
        $this->baseFieldDefinitions[$entity_type_id] = $this->buildBaseFieldDefinitions($entity_type_id);
        $this->cache->set($cid, $this->baseFieldDefinitions[$entity_type_id], Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
       }
     }
    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
   *   \Drupal\Core\Entity\ContentEntityInterface are supported
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   An array of field definitions, keyed by field name.
   *
   * @throws \LogicException
   *   Thrown if one of the entity keys is flagged as translatable.
   */
  protected function buildBaseFieldDefinitions($entity_type_id) {
    $entity_type = $this->getDefinition($entity_type_id);
    $class = $entity_type->getClass();

    $base_field_definitions = $class::baseFieldDefinitions($entity_type);

    // Invoke hook.
    $result = $this->moduleHandler->invokeAll('entity_base_field_info', array($entity_type));
    $base_field_definitions = NestedArray::mergeDeep($base_field_definitions, $result);

    // Automatically set the field name for non-configurable fields.
    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);
      }
    }

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

    // Ensure all basic fields are not defined as translatable.
    $keys = array_intersect_key(array_filter($entity_type->getKeys()), array_flip(array('id', 'revision', 'uuid', 'bundle')));
    $untranslatable_fields = array_flip(array('langcode') + $keys);
    foreach ($base_field_definitions as $field_name => $definition) {
      if (isset($untranslatable_fields[$field_name]) && $definition->isTranslatable()) {
        throw new \LogicException(String::format('The @field field cannot be translatable.', array('@field' => $definition->getLabel())));
354 355 356
      }
    }

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    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;
      if ($cache = $this->cache->get($cid)) {
        $bundle_field_definitions = $cache->data;
      }
      else {
        // Rebuild the definitions and put it into the cache.
        $bundle_field_definitions = $this->buildBuildFieldDefinitions($entity_type_id, $bundle, $base_field_definitions);
        $this->cache->set($cid, $bundle_field_definitions, Cache::PERMANENT, array('entity_types' => TRUE, 'entity_field_info' => TRUE));
      }
      // 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);
381
    }
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    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.
   */
  protected function buildBuildFieldDefinitions($entity_type_id, $bundle, array $base_field_definitions) {
    $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);

    // Invoke 'per bundle' hook.
    $result = $this->moduleHandler->invokeAll('entity_bundle_field_info', array($entity_type, $bundle, $base_field_definitions));
    $bundle_field_definitions = NestedArray::mergeDeep($bundle_field_definitions, $result);

    // Automatically set the field name for non-configurable fields.
    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);
416 417
      }
    }
418 419 420 421 422

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

    return $bundle_field_definitions;
423 424 425
  }

  /**
426
   * {@inheritdoc}
427 428
   */
  public function clearCachedFieldDefinitions() {
429 430
    $this->baseFieldDefinitions = array();
    $this->fieldDefinitions = array();
431
    Cache::deleteTags(array('entity_field_info' => TRUE));
432 433
  }

434
  /**
435
   * {@inheritdoc}
436 437 438 439 440 441 442
   */
  public function getBundleInfo($entity_type) {
    $bundle_info = $this->getAllBundleInfo();
    return isset($bundle_info[$entity_type]) ? $bundle_info[$entity_type] : array();
  }

  /**
443
   * {@inheritdoc}
444 445 446
   */
  public function getAllBundleInfo() {
    if (!isset($this->bundleInfo)) {
447
      $langcode = $this->languageManager->getCurrentLanguage()->id;
448 449 450 451 452 453
      if ($cache = $this->cache->get("entity_bundle_info:$langcode")) {
        $this->bundleInfo = $cache->data;
      }
      else {
        $this->bundleInfo = $this->moduleHandler->invokeAll('entity_bundle_info');
        // If no bundles are provided, use the entity type name and label.
454
        foreach ($this->getDefinitions() as $type => $entity_type) {
455
          if (!isset($this->bundleInfo[$type])) {
456
            $this->bundleInfo[$type][$type]['label'] = $entity_type->getLabel();
457 458 459
          }
        }
        $this->moduleHandler->alter('entity_bundle_info', $this->bundleInfo);
460
        $this->cache->set("entity_bundle_info:$langcode", $this->bundleInfo, Cache::PERMANENT, array('entity_types' => TRUE));
461 462 463 464 465 466
      }
    }

    return $this->bundleInfo;
  }

467
  /**
468
   * {@inheritdoc}
469 470 471 472
   */
  public function getEntityTypeLabels() {
    $options = array();
    foreach ($this->getDefinitions() as $entity_type => $definition) {
473
      $options[$entity_type] = $definition->getLabel();
474 475 476 477 478
    }

    return $options;
  }

479 480 481 482 483 484 485 486
  /**
   * {@inheritdoc}
   */
  public function getTranslationFromContext(EntityInterface $entity, $langcode = NULL, $context = array()) {
    $translation = $entity;

    if ($entity instanceof TranslatableInterface) {
      if (empty($langcode)) {
487
        $langcode = $this->languageManager->getCurrentLanguage(Language::TYPE_CONTENT)->id;
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
      }

      // 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();
      $candidates[$default_language->id] = Language::LANGCODE_DEFAULT;

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

    return $translation;
  }

512
}