PromotionOfferManager.php in Commerce Core 8.2

Namespace

Drupal\commerce_promotion

File

modules/promotion/src/PromotionOfferManager.php

<?php

namespace Drupal\commerce_promotion;

use Drupal\Component\Plugin\Exception\PluginException;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;

/**
 * Manages discovery and instantiation of promotion offer plugins.
 *
 * @see \Drupal\commerce_promotion\Annotation\CommercePromotionOffer
 * @see plugin_api
 */
class PromotionOfferManager extends DefaultPluginManager {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new PromotionOfferManager 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 $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct('Plugin/Commerce/PromotionOffer', $namespaces, $module_handler, 'Drupal\\commerce_promotion\\Plugin\\Commerce\\PromotionOffer\\PromotionOfferInterface', 'Drupal\\commerce_promotion\\Annotation\\CommercePromotionOffer');
    $this
      ->alterInfo('commerce_promotion_offer_info');
    $this
      ->setCacheBackend($cache_backend, 'commerce_promotion_offer_plugins');
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    foreach ([
      'id',
      'label',
      'entity_type',
    ] as $required_property) {
      if (empty($definition[$required_property])) {
        throw new PluginException(sprintf('The promotion offer "%s" must define the %s property.', $plugin_id, $required_property));
      }
    }
    $entity_type_id = $definition['entity_type'];
    if (!$this->entityTypeManager
      ->getDefinition($entity_type_id)) {
      throw new PluginException(sprintf('The promotion offer "%s" must specify a valid entity type, "%s" given.', $plugin_id, $entity_type_id));
    }
  }

}

Classes

Name	Description
PromotionOfferManager	Manages discovery and instantiation of promotion offer plugins.