class ConsentUserResolverPluginManager extends DefaultPluginManager {

  /**
   * Resolvers keyed by entity type.
   *
   * @var array
   */
  protected $resolvers;

  /**
   * Constructs a ConsentUserResolverPluginManager object.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cacheBackend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cacheBackend, ModuleHandlerInterface $moduleHandler) {
    parent::__construct('Plugin/Gdpr/ConsentUserResolver', $namespaces, $moduleHandler, GdprConsentUserResolverInterface::class, GdprConsentUserResolver::class);
    $this
      ->setCacheBackend($cacheBackend, 'gdpr_consent_resolver_plugins');
    $this
      ->alterInfo('gdpr_consent_resolver_info');
  }

  /**
   * Check for an existing resolver for the specified entity type/bundle.
   *
   * @param string $entityType
   *   The entity type.
   * @param string $bundle
   *   The bundle.
   *
   * @return array|bool
   *   The resolver definition, if it exists, or NULL.
   *
   * @throws \Exception
   */
  public function getDefinitionForType($entityType, $bundle) {
    $definitions = $this
      ->getDefinitions();

    // Get all plugins that act on the entity type.
    $definitionsForEntity = \array_filter($definitions, function ($definition) use ($entityType) {
      return $definition['entityType'] === $entityType;
    });
    $definitionsForBundle = \array_filter($definitionsForEntity, function ($definition) use ($bundle) {
      return array_key_exists('bundle', $definition) && $definition['bundle'] === $bundle;
    });
    $definition = NULL;
    if (\count($definitionsForBundle) > 0) {

      // Get first item from the array.
      $definition = \reset($definitionsForBundle);
    }
    elseif (\count($definitionsForEntity) > 0) {

      // None matched for bundle.
      // Find any with no bundle.
      $definitionsForBundle = \array_filter($definitionsForEntity, function ($definition) {
        return !array_key_exists('bundle', $definition) || $definition['bundle'] === '';
      });
      if (\count($definitionsForBundle) > 0) {

        // Get first item from array.
        $definition = \reset($definitionsForBundle);
      }
    }
    if (NULL === $definition) {
      return FALSE;
    }
    return $definition;
  }

  /**
   * Finds a resolver for the specified entity type/bundle.
   *
   * @param string $entityType
   *   The entity type.
   * @param string $bundle
   *   The bundle.
   *
   * @return \Drupal\gdpr_consent\ConsentUserResolver\GdprConsentUserResolverInterface
   *   The resolver that will be used to find the User for a specific entity.
   *
   * @throws \Exception
   */
  public function getForEntityType($entityType, $bundle) {
    $definition = $this
      ->getDefinitionForType($entityType, $bundle);
    if (FALSE === $definition) {
      throw new \Exception("Could not determine user ID for entity type {$entityType}. Please ensure there is a resolver registered.");
    }
    return $this
      ->createInstance($definition['id']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConsentUserResolverPluginManager::$resolvers	protected	property	Resolvers keyed by entity type.
ConsentUserResolverPluginManager::getDefinitionForType	public	function	Check for an existing resolver for the specified entity type/bundle.
ConsentUserResolverPluginManager::getForEntityType	public	function	Finds a resolver for the specified entity type/bundle.
ConsentUserResolverPluginManager::__construct	public	function	Constructs a ConsentUserResolverPluginManager object. Overrides DefaultPluginManager::__construct
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.	9
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.	1
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.	1
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.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	5
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	7
DefaultPluginManager::fixContextAwareDefinitions	private	function	Fix the definitions of context-aware plugins.
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	2
DefaultPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery	12
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions.	13
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches	public	function	Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches	1
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.	1
DiscoveryCachedTrait::getDefinition	public	function	Overrides DiscoveryTrait::getDefinition	3
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function
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	12
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
PluginManagerBase::handlePluginNotFound	protected	function	Allows plugin managers to specify custom behavior if a plugin is not found.	1
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.	1
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class ConsentUserResolverPluginManager in General Data Protection Regulation 8

Hierarchy

File

Namespace

Members

API Navigation