EntityTypeManager

Manages entity type plugin definitions.

Each entity type definition array is set in the entity type's annotation and altered by hook_entity_type_alter().

Do not use hook_entity_type_alter() hook to add information to entity types, unless one of the following is true:

You are filling in default values.
You need to dynamically add information only in certain circumstances.
Your hook needs to run after hook_entity_type_build() implementations.

Use hook_entity_type_build() instead in all other cases.

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\Core\Entity\EntityTypeManager implements EntityTypeManagerInterface, ContainerAwareInterface uses ContainerAwareTrait

File

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

Namespace

Drupal\Core\Entity

Members

Name	Modifiers	Type	Description
ContainerAwareTrait::$container	protected	property
ContainerAwareTrait::setContainer	public	function	Sets the container. Overrides ContainerAwareInterface::setContainer
DefaultPluginManager::$additionalAnnotationNamespaces	protected	property	Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook	protected	property	Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey	protected	property	The cache key.
DefaultPluginManager::$cacheTags	protected	property	An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults	protected	property	A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes.
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface	protected	property	The interface each plugin should implement.
DefaultPluginManager::$subdir	protected	property	The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.
DefaultPluginManager::alterInfo	protected	function	Initializes the alter hook.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions
DefaultPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function	Indicates if a specific plugin definition exists. Overrides DiscoveryInterface::hasDefinition
EntityTypeManager::$classResolver	protected	property	The class resolver.
EntityTypeManager::$handlers	protected	property	Contains instantiated handlers keyed by handler type and entity type.
EntityTypeManager::$stringTranslation	protected	property	The string translation service.
EntityTypeManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides DefaultPluginManager::clearCachedDefinitions
EntityTypeManager::createHandlerInstance	public	function	Creates new handler instance. Overrides EntityTypeManagerInterface::createHandlerInstance
EntityTypeManager::findDefinitions	protected	function	Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
EntityTypeManager::getAccessControlHandler	public	function	Creates a new access control handler instance. Overrides EntityTypeManagerInterface::getAccessControlHandler
EntityTypeManager::getDefinition	public	function	Gets a specific plugin definition. Overrides DiscoveryCachedTrait::getDefinition
EntityTypeManager::getFormObject	public	function	Creates a new form instance. Overrides EntityTypeManagerInterface::getFormObject
EntityTypeManager::getHandler	public	function	Creates a new handler instance for a entity type and handler type. Overrides EntityTypeManagerInterface::getHandler
EntityTypeManager::getListBuilder	public	function	Creates a new entity list builder. Overrides EntityTypeManagerInterface::getListBuilder
EntityTypeManager::getRouteProviders	public	function	Gets all route provider instances. Overrides EntityTypeManagerInterface::getRouteProviders
EntityTypeManager::getStorage	public	function	Creates a new storage instance. Overrides EntityTypeManagerInterface::getStorage
EntityTypeManager::getViewBuilder	public	function	Creates a new view builder instance. Overrides EntityTypeManagerInterface::getViewBuilder
EntityTypeManager::hasHandler	public	function	Checks whether a certain entity type has a certain handler. Overrides EntityTypeManagerInterface::hasHandler
EntityTypeManager::processDefinition	public	function	Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
EntityTypeManager::useCaches	public	function	Disable the use of caches. Overrides DefaultPluginManager::useCaches
EntityTypeManager::__construct	public	function	Constructs a new Entity plugin manager. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery	protected	property	The object that discovers plugins managed by this manager.
PluginManagerBase::$factory	protected	property	The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper	protected	property	The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag.
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21EntityTypeManager.php/class/EntityTypeManager/8.2.x

doc_Drupal

2016-10-29 09:08:34

Comments

EntityTypeManager

Hierarchy

See also

File

Namespace

Members