aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php

   1 <?php
   2
   3 namespace Drupal\Core\Plugin;
   4
   5 use Drupal\Component\Plugin\Definition\PluginDefinitionInterface;
   6 use Drupal\Component\Plugin\DependentPluginInterface;
   7 use Drupal\Component\Plugin\PluginInspectionInterface;
   8 use Drupal\Core\Entity\DependencyTrait;
   9 use Drupal\Core\Plugin\Definition\DependentPluginDefinitionInterface;
  10
  11 /**
  12  * Provides a trait for calculating the dependencies of a plugin.
  13  */
  14 trait PluginDependencyTrait {
  15
  16   use DependencyTrait;
  17
  18   /**
  19    * Calculates and adds dependencies of a specific plugin instance.
  20    *
  21    * Dependencies are added for the module that provides the plugin, as well
  22    * as any dependencies declared by the instance's calculateDependencies()
  23    * method, if it implements
  24    * \Drupal\Component\Plugin\DependentPluginInterface.
  25    *
  26    * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
  27    *   The plugin instance.
  28    */
  29   protected function calculatePluginDependencies(PluginInspectionInterface $instance) {
  30     $definition = $instance->getPluginDefinition();
  31
  32     if ($definition instanceof PluginDefinitionInterface) {
  33       $this->addDependency('module', $definition->getProvider());
  34       if ($definition instanceof DependentPluginDefinitionInterface && $config_dependencies = $definition->getConfigDependencies()) {
  35         $this->addDependencies($config_dependencies);
  36       }
  37     }
  38     elseif (is_array($definition)) {
  39       $this->addDependency('module', $definition['provider']);
  40       // Plugins can declare additional dependencies in their definition.
  41       if (isset($definition['config_dependencies'])) {
  42         $this->addDependencies($definition['config_dependencies']);
  43       }
  44     }
  45
  46     // If a plugin is dependent, calculate its dependencies.
  47     if ($instance instanceof DependentPluginInterface && $plugin_dependencies = $instance->calculateDependencies()) {
  48       $this->addDependencies($plugin_dependencies);
  49     }
  50   }
  51
  52 }