EntityTypeRepository.php in Zircon Profile 8
Same filename and directory in other branches
Contains \Drupal\Core\Entity\EntityTypeRepository.
Namespace
Drupal\Core\EntityFile
core/lib/Drupal/Core/Entity/EntityTypeRepository.phpView source
<?php
/**
* @file
* Contains \Drupal\Core\Entity\EntityTypeRepository.
*/
namespace Drupal\Core\Entity;
use Drupal\Core\Entity\Exception\AmbiguousEntityClassException;
use Drupal\Core\Entity\Exception\NoCorrespondingEntityClassException;
use Drupal\Core\StringTranslation\StringTranslationTrait;
/**
* Provides helper methods for loading entity types.
*
* @see \Drupal\Core\Entity\EntityTypeManagerInterface
*/
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 = [];
/**
* Constructs a new EntityTypeRepository.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager) {
$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', array(), array(
'context' => 'Entity type group',
));
$options = array(
(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;
foreach ($this->entityTypeManager
->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);
}
/**
* {@inheritdoc}
*/
public function clearCachedDefinitions() {
$this->classNameEntityTypeMap = [];
}
}
Classes
Name![]() |
Description |
---|---|
EntityTypeRepository | Provides helper methods for loading entity types. |