public function EntityTypeManager::getDefinition

public EntityTypeManager::getDefinition($entity_type_id, $exception_on_invalid = TRUE)

Gets a specific plugin definition.

Parameters

string $plugin_id: A plugin id.

bool $exception_on_invalid: (optional) If TRUE, an invalid plugin ID will throw an exception.

Return value

mixed A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is FALSE.

Throws

\Drupal\Component\Plugin\Exception\PluginNotFoundException Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.

Overrides DiscoveryCachedTrait::getDefinition

File

core/lib/Drupal/Core/Entity/EntityTypeManager.php, line 117

Class

EntityTypeManager

Manages entity type plugin definitions.

Namespace

Drupal\Core\Entity

Code

public function getDefinition($entity_type_id, $exception_on_invalid = TRUE) {
  if (($entity_type = parent::getDefinition($entity_type_id, FALSE)) && class_exists($entity_type->getClass())) {
    return $entity_type;
  }
  elseif (!$exception_on_invalid) {
    return NULL;
  }

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