IdentityChannelManager.php in Courier 8

Namespace

Drupal\courier\Service

File

src/Service/IdentityChannelManager.php

<?php

namespace Drupal\courier\Service;

use Drupal\Component\Plugin\FallbackPluginManagerInterface;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;
use Drupal\Core\Entity\EntityInterface;

/**
 * Manages discovery and instantiation of CourierIdentity plugins.
 */
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;
  }

}

Classes

Name	Description
IdentityChannelManager	Manages discovery and instantiation of CourierIdentity plugins.