You are here

Home » API reference » Commerce Shipping 8.2 » PackageTypeManager.php

class PackageTypeManager in Commerce Shipping 8.2

Manages discovery and instantiation of package type plugins.

Hierarchy

Expanded class hierarchy of PackageTypeManager

See also

\Drupal\commerce_shipping\Plugin\Commerce\PackageType\PackageTypeInterface

Plugin API

1 string reference to 'PackageTypeManager'
commerce_shipping.services.yml in ./commerce_shipping.services.yml
commerce_shipping.services.yml
1 service uses PackageTypeManager
plugin.manager.commerce_package_type in ./commerce_shipping.services.yml
Drupal\commerce_shipping\PackageTypeManager

File

src/PackageTypeManager.php, line 20

Namespace

Drupal\commerce_shipping
View source 
class PackageTypeManager extends DefaultPluginManager implements PackageTypeManagerInterface {

  /**
   * Default values for each package type plugin.
   *
   * @var array
   */
  protected $defaults = [
    'id' => '',
    'remote_id' => '',
    'label' => '',
    'dimensions' => [],
    'weight' => NULL,
    // A shipping method plugin ID. Used to optionally restrict the package type
    // to shipping methods with the specified plugin.
    'shipping_method' => NULL,
    'class' => PackageType::class,
  ];

  /**
   * Constructs a new PackageTypeManager object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend.
   */
  public function __construct(ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend) {
    $this->moduleHandler = $module_handler;
    $this
      ->setCacheBackend($cache_backend, 'commerce_package_type_plugins');
  }

  /**
   * {@inheritdoc}
   */
  protected function getDiscovery() {
    if (!isset($this->discovery)) {
      $this->discovery = new YamlDiscovery('commerce_package_types', $this->moduleHandler
        ->getModuleDirectories());
      $this->discovery
        ->addTranslatableProperty('label', 'label_context');
      $this->discovery = new ContainerDerivativeDiscoveryDecorator($this->discovery);
    }
    return $this->discovery;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    $definition['id'] = $plugin_id;
    foreach ([
      'remote_id',
      'label',
      'dimensions',
    ] as $required_property) {
      if (empty($definition[$required_property])) {
        throw new PluginException(sprintf('The package_type "%s" must define the "%s" property.', $plugin_id, $required_property));
      }
    }
    foreach ([
      'length',
      'width',
      'height',
      'unit',
    ] as $dimension_property) {
      if (empty($definition['dimensions'][$dimension_property])) {
        throw new PluginException(sprintf('The package type "%s" property "dimensions" must have a "%s" key.', $plugin_id, $dimension_property));
      }
    }
    if (isset($definition['weight'])) {
      foreach ([
        'number',
        'unit',
      ] as $weight_property) {
        if (!isset($definition['weight'][$weight_property])) {
          throw new PluginException(sprintf('The package type "%s" property "weight" must have a "%s" key.', $plugin_id, $weight_property));
        }
      }
    }
    else {

      // Package types should have a weight value even if they're weightless.
      $definition['weight'] = [
        'number' => 0,
        'unit' => WeightUnit::GRAM,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitionsByShippingMethod($shipping_method) {
    $definitions = $this
      ->getDefinitions();
    foreach ($definitions as $id => $definition) {
      if (!empty($definition['shipping_method']) && $definition['shipping_method'] != $shipping_method) {
        unset($definitions[$id]);
      }
    }
    uasort($definitions, function ($a, $b) {
      return strnatcasecmp($a['label'], $b['label']);
    });
    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::$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 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
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::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
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
PackageTypeManager::$defaults protected property Default values for each package type plugin. Overrides DefaultPluginManager::$defaults
PackageTypeManager::getDefinitionsByShippingMethod public function Gets the definitions for the given shipping method plugin ID. Overrides PackageTypeManagerInterface::getDefinitionsByShippingMethod
PackageTypeManager::getDiscovery protected function Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
PackageTypeManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
PackageTypeManager::__construct public function Constructs a new PackageTypeManager object. 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 7
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. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.