PluginDependencyTrait.php 1.9 KB

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