You are here

Home » API reference » Courier 2.x » IdentityChannelManager.php

class IdentityChannelManager in Courier 2.x

Same name and namespace in other branches
  1. 8 src/Service/IdentityChannelManager.php \Drupal\courier\Service\IdentityChannelManager

Manages discovery and instantiation of CourierIdentity plugins.

Hierarchy

Expanded class hierarchy of IdentityChannelManager

1 string reference to 'IdentityChannelManager'
courier.services.yml in ./courier.services.yml
courier.services.yml
1 service uses IdentityChannelManager
plugin.manager.identity_channel in ./courier.services.yml
Drupal\courier\Service\IdentityChannelManager

File

src/Service/IdentityChannelManager.php, line 14

Namespace

Drupal\courier\Service
View source 
class IdentityChannelManager extends DefaultPluginManager implements IdentityChannelManagerInterface, FallbackPluginManagerInterface {

  /**
   * Constructs a new identity channel manager.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/IdentityChannel', $namespaces, $module_handler, 'Drupal\\courier\\Plugin\\IdentityChannel\\IdentityChannelPluginInterface', 'Drupal\\courier\\Annotation\\IdentityChannel');
    $this
      ->alterInfo('courier_identity_channel_info');
    $this
      ->setCacheBackend($cache_backend, 'courier_identity_channel_info_plugins');
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackPluginId($plugin_id, array $configuration = []) {
    return 'broken';
  }

  /**
   * {@inheritdoc}
   */
  public function getCourierIdentityPluginID($channel_type_id, $identity_type_id) {
    foreach ($this
      ->getNonFallbackDefinitions() as $plugin_id => $plugin) {
      if ($plugin['channel'] == $channel_type_id && $identity_type_id == $plugin['identity']) {
        return $plugin_id;
      }
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getCourierIdentity($channel_type_id, $identity_type_id) {
    if ($plugin_id = $this
      ->getCourierIdentityPluginID($channel_type_id, $identity_type_id)) {
      return $this
        ->createInstance($plugin_id);
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getChannels() {
    $channels = [];
    foreach ($this
      ->getNonFallbackDefinitions() as $plugin_id => $plugin) {
      $channel = $plugin['channel'];
      $identity_type = $plugin['identity'];
      if (!isset($channels[$channel]) || !in_array($identity_type, $channels[$channel])) {
        $channels[$channel][] = $identity_type;
      }
    }
    return $channels;
  }

  /**
   * {@inheritdoc}
   */
  public function getIdentityTypes() {
    $identity_types = [];
    foreach ($this
      ->getNonFallbackDefinitions() as $plugin_id => $plugin) {
      if (!in_array($plugin['identity'], $identity_types)) {
        $identity_types[] = $plugin['identity'];
      }
    }
    return $identity_types;
  }

  /**
   * {@inheritdoc}
   */
  public function getChannelsForIdentityType($identity_type_id) {
    $channels = [];
    foreach ($this
      ->getChannels() as $channel => $identity_types) {
      if (in_array($identity_type_id, $identity_types)) {
        $channels[] = $channel;
      }
    }
    return $channels;
  }

  /**
   * {@inheritdoc}
   *
   * @todo: Determine channel preference for individual identities.
   * GH-2 | https://github.com/dpi/courier/issues/2
   */
  public function getChannelsForIdentity(EntityInterface $identity) {
    $preferences = \Drupal::config('courier.settings')
      ->get('channel_preferences');
    $identity_type = $identity
      ->getEntityTypeId();
    if (array_key_exists($identity_type, $preferences)) {
      return array_intersect($preferences[$identity_type], $this
        ->getChannelsForIdentityType($identity_type));
    }
    return [];
  }

  /**
   * Get a list of non-broken plugins.
   *
   * @return array
   *   A list of IdentityChannel plugins keyed by plugin ID.
   */
  protected function getNonFallbackDefinitions() {
    $definitions = $this
      ->getDefinitions();
    unset($definitions['broken']);
    return $definitions;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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 6
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
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
IdentityChannelManager::getChannels public function Gets all channel implementations. Overrides IdentityChannelManagerInterface::getChannels
IdentityChannelManager::getChannelsForIdentity public function @todo: Determine channel preference for individual identities. GH-2 | https://github.com/dpi/courier/issues/2 Overrides IdentityChannelManagerInterface::getChannelsForIdentity
IdentityChannelManager::getChannelsForIdentityType public function Get channels supported for an identity entity type. Overrides IdentityChannelManagerInterface::getChannelsForIdentityType
IdentityChannelManager::getCourierIdentity public function Instantiate a CourierIdentity plugin instance. Overrides IdentityChannelManagerInterface::getCourierIdentity
IdentityChannelManager::getCourierIdentityPluginID public function Get IdentityChannel plugin ID bridging a identity and message combination. Overrides IdentityChannelManagerInterface::getCourierIdentityPluginID
IdentityChannelManager::getFallbackPluginId public function Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
IdentityChannelManager::getIdentityTypes public function Gets all identity types. Overrides IdentityChannelManagerInterface::getIdentityTypes
IdentityChannelManager::getNonFallbackDefinitions protected function Get a list of non-broken plugins.
IdentityChannelManager::__construct public function Constructs a new identity channel 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 12
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 6
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.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.