BillingScheduleManager.php in Commerce Recurring Framework 8

Namespace

Drupal\commerce_recurring

File

src/BillingScheduleManager.php

<?php

namespace Drupal\commerce_recurring;

use Drupal\commerce_recurring\Annotation\CommerceBillingSchedule;
use Drupal\commerce_recurring\Plugin\Commerce\BillingSchedule\BillingScheduleInterface;
use Drupal\Component\Plugin\Exception\PluginException;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;

/**
 * Manages discovery and instantiation of billing schedule plugins.
 *
 * @see \Drupal\commerce_recurring\Annotation\BillingSchedule
 * @see plugin_api
 */
class BillingScheduleManager extends DefaultPluginManager {

  /**
   * Constructs a new BillingScheduleManager 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
   *   The cache backend.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/Commerce/BillingSchedule', $namespaces, $module_handler, BillingScheduleInterface::class, CommerceBillingSchedule::class);
    $this
      ->alterInfo('commerce_billing_schedule_info');
    $this
      ->setCacheBackend($cache_backend, 'commerce_billing_schedule_plugins');
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    foreach ([
      'id',
      'label',
    ] as $required_property) {
      if (empty($definition[$required_property])) {
        throw new PluginException(sprintf('The billing schedule "%s" must define the "%s" property.', $plugin_id, $required_property));
      }
    }
  }

}

Classes

Name	Description
BillingScheduleManager	Manages discovery and instantiation of billing schedule plugins.