You are here

final class DependencyCalculatorEvents in Dependency Calculation 8

Defines events for the depcalc module.

Hierarchy

Expanded class hierarchy of DependencyCalculatorEvents

See also

\Drupal\depcalc\Event\CalculateEntityDependenciesEvent

24 files declare their use of DependencyCalculatorEvents
BlockContentDependencyCollector.php in src/EventSubscriber/LayoutBuilderComponentDepencyCollector/BlockContentDependencyCollector.php
CalculateDependenciesEventDispatcherTrait.php in tests/src/Kernel/EventSubscriber/DependencyCollector/CalculateDependenciesEventDispatcherTrait.php
ConfigDependencyCollector.php in src/EventSubscriber/LayoutBuilderComponentDepencyCollector/ConfigDependencyCollector.php
ConfigEntityDependencyCollector.php in src/EventSubscriber/DependencyCollector/ConfigEntityDependencyCollector.php
DepcalcCacheBackend.php in src/Cache/DepcalcCacheBackend.php

... See full list

File

src/DependencyCalculatorEvents.php, line 10

Namespace

Drupal\depcalc
View source
final class DependencyCalculatorEvents {

  /**
   * Name of the event fired when an entity's dependencies are calculated.
   *
   * This event allows modules to collaborate on entity dependency calculation.
   * The event listener method receives a
   * \Drupal\depcalc\Event\CalculateEntityDependenciesEvent instance.
   *
   * @Event
   *
   * @see \Drupal\depcalc\Event\CalculateEntityDependenciesEvent
   * @see \Drupal\depcalc\DependencyCalculator::calculateDependencies
   *
   * @var string
   */
  const CALCULATE_DEPENDENCIES = "calculate_dependencies";

  /**
   * The event fired against isolated fields for dependency calculation.
   *
   * The event listener method receives a
   * \Drupal\depcalc\Event\FilterDependencyCalculationFieldsEvent instance.
   *
   * @Event
   *
   * @see \Drupal\depcalc\Event\FilterDependencyCalculationFieldsEvent
   * @see \Drupal\depcalc\FieldExtractor::getFieldsFromEntity
   */
  const FILTER_FIELDS = "depcalc_filter_fields";

  /**
   * The event fired against config entities for dependency calculation.
   *
   * The event listener method receives a
   * \Drupal\depcalc\Event\FilterDependencyConfigEntityEvent instance.
   *
   * @Event
   *
   * @see \Drupal\depcalc\Event\FilterDependencyConfigEntityEvent
   * @see \Drupal\depcalc\EventSubscriber\DependencyCollector\ConfigEntityDependencyCollector::onCalculateDependencies
   */
  const FILTER_CONFIG_ENTITIES = "depcalc_filter_config_entities";

  /**
   * Name of the event fired when dependencies from a Layout Builder component are calculated.
   *
   * The event listener method receives a
   * \Drupal\depcalc\Event\CalculateLayoutBuilderComponentDependenciesEvent instance.
   *
   * @Event
   *
   * @see \Drupal\depcalc\Event\SectionComponentDependenciesEvent
   * @see \Drupal\depcalc\EventSubscriber\DependencyCollector\LayoutBuilderFieldDependencyCollector
   *
   * @var string
   */
  const SECTION_COMPONENT_DEPENDENCIES_EVENT = "section_component_dependencies_event";

  /**
   * Name of the event fired with a dependency is invalidated from the cache.
   *
   * The event listener method recieves a
   * \Drupal\depcalc\Event\InvalidateDependenciesEvent instance.
   *
   * @Event
   *
   * @see \Drupal\depcalc\Cache\DepcalcCacheBackend
   */
  const INVALIDATE_DEPENDENCIES = "depcalc_invalidate_dependencies";

}

Members

Namesort descending Modifiers Type Description Overrides
DependencyCalculatorEvents::CALCULATE_DEPENDENCIES constant Name of the event fired when an entity's dependencies are calculated.
DependencyCalculatorEvents::FILTER_CONFIG_ENTITIES constant The event fired against config entities for dependency calculation.
DependencyCalculatorEvents::FILTER_FIELDS constant The event fired against isolated fields for dependency calculation.
DependencyCalculatorEvents::INVALIDATE_DEPENDENCIES constant Name of the event fired with a dependency is invalidated from the cache.
DependencyCalculatorEvents::SECTION_COMPONENT_DEPENDENCIES_EVENT constant Name of the event fired when dependencies from a Layout Builder component are calculated.