class ConfigEntityDependencyCollector in Dependency Calculation 8

The config dependency collector.

Hierarchy

• class \Drupal\depcalc\EventSubscriber\DependencyCollector\BaseDependencyCollector implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
  • class \Drupal\depcalc\EventSubscriber\DependencyCollector\ConfigEntityDependencyCollector

1 string reference to 'ConfigEntityDependencyCollector'

depcalc.services.yml in ./depcalc.services.yml

depcalc.services.yml

1 service uses ConfigEntityDependencyCollector

entity.config_entity.dependency_calculator in ./depcalc.services.yml

Drupal\depcalc\EventSubscriber\DependencyCollector\ConfigEntityDependencyCollector

File

src/EventSubscriber/DependencyCollector/ConfigEntityDependencyCollector.php, line 16

Namespace

Drupal\depcalc\EventSubscriber\DependencyCollector

class ConfigEntityDependencyCollector extends BaseDependencyCollector {

  /**
   * The configuration manager.
   *
   * @var \Drupal\Core\Config\ConfigManagerInterface
   */
  protected $configManager;

  /**
   * ConfigEntityDependencyCollector constructor.
   *
   * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
   *   The configuration manager.
   */
  public function __construct(ConfigManagerInterface $config_manager) {
    $this->configManager = $config_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[DependencyCalculatorEvents::CALCULATE_DEPENDENCIES][] = [
      'onCalculateDependencies',
    ];
    return $events;
  }

  /**
   * Calculates config entity dependencies.
   *
   * @param \Drupal\depcalc\Event\CalculateEntityDependenciesEvent $event
   *   The dependency calculation event.
   * @param string $event_name
   *   The name of the event.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
   *   The event dispatcher.
   *
   * @throws \Exception
   */
  public function onCalculateDependencies(CalculateEntityDependenciesEvent $event, string $event_name, EventDispatcherInterface $dispatcher) {
    $entity = $event
      ->getEntity();
    if ($entity instanceof ConfigEntityInterface) {
      $wrapper = $event
        ->getWrapper();
      $dependencies = $event
        ->getDependencies();
      $entity_dependencies = $entity
        ->getDependencies();
      if (isset($entity_dependencies['config'])) {
        $idKey = "{$entity->getEntityType()->getConfigPrefix()}.{$entity->get($entity->getEntityType()->getKey('id'))}";
        $key = array_search($idKey, $entity_dependencies['config']);
        if ($key !== FALSE) {
          unset($entity_dependencies['config'][$key]);
        }
      }
      if (!empty($entity_dependencies['content'])) {

        // @todo figure out how this is stored and iterate over it.
      }

      // Handle config and config entities.
      if (!empty($entity_dependencies['config'])) {
        foreach ($entity_dependencies['config'] as $dependency) {
          $sub_entity = $this->configManager
            ->loadConfigEntityByName($dependency);
          if ($sub_entity) {
            $sub_wrapper = new DependentEntityWrapper($sub_entity);
            $config_dependency_event = new FilterDependencyConfigEntityEvent($sub_wrapper);
            $dispatcher
              ->dispatch(DependencyCalculatorEvents::FILTER_CONFIG_ENTITIES, $config_dependency_event);
            if (!$config_dependency_event
              ->isCalculable()) {
              continue;
            }
            $local_dependencies = [];
            $sub_dependencies = $this
              ->getCalculator()
              ->calculateDependencies($sub_wrapper, $event
              ->getStack(), $local_dependencies);
            unset($sub_dependencies['module']);
            $sub_wrapper
              ->addDependencies($event
              ->getStack(), ...array_values($sub_dependencies));
            $wrapper
              ->addDependency($sub_wrapper, $event
              ->getStack());
          }
          else {
            $dependencies['raw_config'][$dependency] = $this->configManager
              ->getConfigFactory()
              ->get($dependency);
          }
        }
      }
      $event
        ->addDependency($wrapper);
      if (!empty($entity_dependencies['module'])) {
        $event
          ->setModuleDependencies($entity_dependencies['module']);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BaseDependencyCollector::getCalculator	protected	function	Gets the dependency calculator.
BaseDependencyCollector::mergeDependencies	protected	function	Properly adds dependencies and their modules to a wrapper object.
ConfigEntityDependencyCollector::$configManager	protected	property	The configuration manager.
ConfigEntityDependencyCollector::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
ConfigEntityDependencyCollector::onCalculateDependencies	public	function	Calculates config entity dependencies.
ConfigEntityDependencyCollector::__construct	public	function	ConfigEntityDependencyCollector constructor.