class EntityTypeRepository

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityTypeRepository.php \Drupal\Core\Entity\EntityTypeRepository
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityTypeRepository.php \Drupal\Core\Entity\EntityTypeRepository
  3. 10 core/lib/Drupal/Core/Entity/EntityTypeRepository.php \Drupal\Core\Entity\EntityTypeRepository

Provides helper methods for loading entity types.

Hierarchy

Expanded class hierarchy of EntityTypeRepository

See also

\Drupal\Core\Entity\EntityTypeManagerInterface

1 file declares its use of EntityTypeRepository
EntityTypeRepositoryTest.php in core/tests/Drupal/Tests/Core/Entity/EntityTypeRepositoryTest.php
1 string reference to 'EntityTypeRepository'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses EntityTypeRepository
entity_type.repository in core/core.services.yml
Drupal\Core\Entity\EntityTypeRepository

File

core/lib/Drupal/Core/Entity/EntityTypeRepository.php, line 15

Namespace

Drupal\Core\Entity
View source
class EntityTypeRepository implements EntityTypeRepositoryInterface {
  use StringTranslationTrait;
  
  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  
  /**
   * Contains cached mappings of class names to entity types.
   *
   * @var array
   */
  protected $classNameEntityTypeMap = [];
  public function __construct(EntityTypeManagerInterface $entity_type_manager, protected EntityTypeBundleInfoInterface $entityTypeBundleInfo) {
    $this->entityTypeManager = $entity_type_manager;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getEntityTypeLabels($group = FALSE) {
    $options = [];
    $definitions = $this->entityTypeManager
      ->getDefinitions();
    foreach ($definitions as $entity_type_id => $definition) {
      if ($group) {
        $options[(string) $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', [], [
        'context' => 'Entity type group',
      ]);
      $options = [
        (string) $content => $options[(string) $content],
      ] + $options;
    }
    return $options;
  }
  
  /**
   * {@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;
    $definitions = $this->entityTypeManager
      ->getDefinitions();
    foreach ($definitions 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);
        }
      }
    }
    // If no match was found check if it is a bundle class. This needs to be in
    // a separate loop to avoid false positives, since an entity class can
    // subclass another entity class.
    if (!$entity_type_id) {
      $bundle_info = $this->entityTypeBundleInfo
        ->getAllBundleInfo();
      foreach ($bundle_info as $info_entity_type_id => $bundles) {
        foreach ($bundles as $info) {
          if (isset($info['class']) && $info['class'] === $class_name) {
            $entity_type_id = $info_entity_type_id;
            if ($same_class++) {
              throw new AmbiguousBundleClassException($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);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
EntityTypeRepository::$classNameEntityTypeMap protected property Contains cached mappings of class names to entity types.
EntityTypeRepository::$entityTypeManager protected property The entity type manager.
EntityTypeRepository::getEntityTypeFromClass public function Gets the entity type ID based on the class that is called on. Overrides EntityTypeRepositoryInterface::getEntityTypeFromClass
EntityTypeRepository::getEntityTypeLabels public function Builds a list of entity type labels suitable for a Form API options list. Overrides EntityTypeRepositoryInterface::getEntityTypeLabels
EntityTypeRepository::__construct public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.