ReportTypeManager.php in Commerce Reporting 8

Namespace

Drupal\commerce_reports

File

src/ReportTypeManager.php

<?php

namespace Drupal\commerce_reports;

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 payment method type plugins.
 *
 * @see \Drupal\commerce_reports\Annotation\ReportType
 * @see plugin_api
 */
class ReportTypeManager extends DefaultPluginManager {

  /**
   * Constructs a new OrderReportTypeManager 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/ReportType', $namespaces, $module_handler, 'Drupal\\commerce_reports\\Plugin\\Commerce\\ReportType\\ReportTypeInterface', 'Drupal\\commerce_reports\\Annotation\\CommerceReportType');
    $this
      ->alterInfo('commerce_report_type_info');
    $this
      ->setCacheBackend($cache_backend, 'commerce_report_type_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 report type %s must define the %s property.', $plugin_id, $required_property));
      }
    }
  }

}

Classes

Name	Description
ReportTypeManager	Manages discovery and instantiation of payment method type plugins.