class ReactionRuleStorage in Rules 8.3

Storage handler for Reaction Rule configuration entities.

@todo Create an interface for this.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
    • class \Drupal\Core\Config\Entity\ConfigEntityStorage implements ConfigEntityStorageInterface, ImportableEntityStorageInterface
      • class \Drupal\rules\Entity\ReactionRuleStorage

File

src/Entity/ReactionRuleStorage.php, line 23

Namespace

Drupal\rules\Entity

class ReactionRuleStorage extends ConfigEntityStorage {

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $stateService;

  /**
   * The Drupal kernel.
   *
   * @var \Drupal\Core\DrupalKernelInterface
   */
  protected $drupalKernel;

  /**
   * The event manager.
   *
   * @var \Drupal\rules\Core\RulesEventManager
   */
  protected $eventManager;

  /**
   * Constructs a ReactionRuleStorage object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Component\Uuid\UuidInterface $uuid_service
   *   The UUID service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\State\StateInterface $state_service
   *   The state service.
   * @param \Drupal\Core\DrupalKernelInterface $drupal_kernel
   *   The Drupal kernel.
   * @param \Drupal\rules\Core\RulesEventManager $event_manager
   *   The Rules event manager.
   * @param \Drupal\Core\Cache\MemoryCache\MemoryCacheInterface|null $memory_cache
   *   The memory cache backend.
   */
  public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, StateInterface $state_service, DrupalKernelInterface $drupal_kernel, RulesEventManager $event_manager, MemoryCacheInterface $memory_cache = NULL) {
    parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager, $memory_cache);
    $this->stateService = $state_service;
    $this->drupalKernel = $drupal_kernel;
    $this->eventManager = $event_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('config.factory'), $container
      ->get('uuid'), $container
      ->get('language_manager'), $container
      ->get('state'), $container
      ->get('kernel'), $container
      ->get('plugin.manager.rules_event'), $container
      ->get('entity.memory_cache'));
  }

  /**
   * Returns a list of event names that are used by active reaction rules.
   *
   * @return string[]
   *   The list of event names keyed by event name.
   */
  protected function getRegisteredEvents() {
    $events = [];

    // 'status' == TRUE when the reaction rule is active.
    foreach ($this
      ->loadByProperties([
      'status' => TRUE,
    ]) as $rules_config) {
      foreach ($rules_config
        ->getEventNames() as $event_name) {
        $event_name = $this->eventManager
          ->getEventBaseName($event_name);
        if (!isset($events[$event_name])) {
          $events[$event_name] = $event_name;
        }
      }
    }
    return $events;
  }

  /**
   * {@inheritdoc}
   */
  public function save(EntityInterface $entity) {

    // We need to get the registered events before the rule is saved, in order
    // to be able to check afterwards if we need to rebuild the container or
    // not.
    $events_before = $this
      ->getRegisteredEvents();
    $return = parent::save($entity);
    $events_after = $this
      ->getRegisteredEvents();

    // Update the state of registered events.
    $this->stateService
      ->set('rules.registered_events', $events_after);

    // After the reaction rule is saved, we may need to rebuild the container,
    // otherwise the reaction rule will not fire. However, we can do an
    // optimization: Only rebuild the container if there is a new event which
    // was not already registered before. Similarly if the rule is being
    // disabled and there are no other active rules with this event, then also
    // rebuild the container.
    foreach ($entity
      ->getEventNames() as $event_name) {
      if (empty($events_before[$event_name]) || empty($events_after[$event_name])) {
        $this->drupalKernel
          ->rebuildContainer();
        break;
      }
    }

    // When a reaction rule is saved (either added, updated or enabled/disabled)
    // the cache for its event(s) needs to be invalidated. These tags are set in
    // RulesComponentRepository::getMultiple()
    Cache::invalidateTags($entity
      ->getEventNames());
    return $return;
  }

  /**
   * {@inheritdoc}
   */
  public function delete(array $entities) {

    // When a rule is deleted the cache for its event(s) must be invalidated.
    foreach ($entities as $entity) {
      Cache::invalidateTags($entity
        ->getEventNames());
    }

    // After deleting a set of reaction rules, sometimes we may need to rebuild
    // the container, to clean it up, so that the generic subscriber is not
    // registered in the container for the rule events which we do not use
    // anymore. So we do that if there is any change in the registered events,
    // after the reaction rules are deleted.
    $events_before = $this
      ->getRegisteredEvents();
    $return = parent::delete($entities);
    $events_after = $this
      ->getRegisteredEvents();

    // Update the state of registered events and rebuild the container.
    if ($events_before != $events_after) {
      $this->stateService
        ->set('rules.registered_events', $events_after);
      $this->drupalKernel
        ->rebuildContainer();
    }
    return $return;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityStorage::$configFactory	protected	property	The config factory service.
ConfigEntityStorage::$configStorage	protected	property	The config storage service.
ConfigEntityStorage::$entities	protected	property	Static cache of entities, keyed first by entity ID, then by an extra key.
ConfigEntityStorage::$languageManager	protected	property	The language manager.
ConfigEntityStorage::$overrideFree	protected	property	Determines if the underlying configuration is retrieved override free.
ConfigEntityStorage::$uuidKey	protected	property	Name of entity's UUID database table field, if it supports UUIDs. Overrides EntityStorageBase::$uuidKey
ConfigEntityStorage::buildCacheId	protected	function	Builds the cache ID for the passed in entity ID. Overrides EntityStorageBase::buildCacheId
ConfigEntityStorage::createFromStorageRecord	public	function	Creates a configuration entity from storage values. Overrides ConfigEntityStorageInterface::createFromStorageRecord
ConfigEntityStorage::deleteRevision	public	function	Delete a specific entity revision. Overrides EntityStorageInterface::deleteRevision
ConfigEntityStorage::doCreate	protected	function	Performs storage-specific creation of entities. Overrides EntityStorageBase::doCreate
ConfigEntityStorage::doDelete	protected	function	Performs storage-specific entity deletion. Overrides EntityStorageBase::doDelete
ConfigEntityStorage::doLoadMultiple	protected	function	Performs storage-specific loading of entities. Overrides EntityStorageBase::doLoadMultiple
ConfigEntityStorage::doSave	protected	function	Performs storage-specific saving of the entity. Overrides EntityStorageBase::doSave
ConfigEntityStorage::getIDFromConfigName	public static	function	Extracts the configuration entity ID from the full configuration name. Overrides ConfigEntityStorageInterface::getIDFromConfigName
ConfigEntityStorage::getPrefix	protected	function	Returns the prefix used to create the configuration name.
ConfigEntityStorage::getQueryServiceName	protected	function	Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase::getQueryServiceName
ConfigEntityStorage::has	protected	function	Determines if this entity already exists in storage. Overrides EntityStorageBase::has
ConfigEntityStorage::hasData	public	function	Determines if the storage contains any data. Overrides EntityStorageBase::hasData
ConfigEntityStorage::importCreate	public	function	Creates entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importCreate	1
ConfigEntityStorage::importDelete	public	function	Delete entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importDelete	2
ConfigEntityStorage::importRename	public	function	Renames entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importRename
ConfigEntityStorage::importUpdate	public	function	Updates entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importUpdate	1
ConfigEntityStorage::invokeHook	protected	function	Invokes a hook on behalf of the entity. Overrides EntityStorageBase::invokeHook
ConfigEntityStorage::loadMultipleOverrideFree	public	function	Loads one or more entities in their original form without overrides. Overrides ConfigEntityStorageInterface::loadMultipleOverrideFree
ConfigEntityStorage::loadOverrideFree	public	function	Loads one entity in their original form without overrides. Overrides ConfigEntityStorageInterface::loadOverrideFree
ConfigEntityStorage::loadRevision	public	function	Load a specific entity revision. Overrides EntityStorageInterface::loadRevision
ConfigEntityStorage::mapToStorageRecord	protected	function	Maps from an entity object to the storage record.	3
ConfigEntityStorage::MAX_ID_LENGTH		constant	Length limit of the configuration entity ID.	1
ConfigEntityStorage::updateFromStorageRecord	public	function	Updates a configuration entity from storage values. Overrides ConfigEntityStorageInterface::updateFromStorageRecord
ConfigEntityStorage::_doCreateFromStorageRecord	protected	function	Helps create a configuration entity from storage values.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityStorageBase::$entityClass	protected	property	Name of the entity class.
EntityStorageBase::$entityType	protected	property	Information about the entity type.
EntityStorageBase::$entityTypeId	protected	property	Entity type ID for this storage.
EntityStorageBase::$idKey	protected	property	Name of the entity's ID field in the entity database table.
EntityStorageBase::$langcodeKey	protected	property	The name of the entity langcode property.	1
EntityStorageBase::$memoryCache	protected	property	The memory cache.
EntityStorageBase::$memoryCacheTag	protected	property	The memory cache cache tag.
EntityStorageBase::$uuidService	protected	property	The UUID service.	1
EntityStorageBase::buildPropertyQuery	protected	function	Builds an entity query.	1
EntityStorageBase::create	public	function	Constructs a new entity object, without permanently saving it. Overrides EntityStorageInterface::create	1
EntityStorageBase::doPostSave	protected	function	Performs post save entity processing.	1
EntityStorageBase::doPreSave	protected	function	Performs presave entity processing.	1
EntityStorageBase::getAggregateQuery	public	function	Gets an aggregated query instance. Overrides EntityStorageInterface::getAggregateQuery
EntityStorageBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityStorageInterface::getEntityType
EntityStorageBase::getEntityTypeId	public	function	Gets the entity type ID. Overrides EntityStorageInterface::getEntityTypeId
EntityStorageBase::getFromStaticCache	protected	function	Gets entities from the static cache.
EntityStorageBase::getQuery	public	function	Gets an entity query instance. Overrides EntityStorageInterface::getQuery
EntityStorageBase::load	public	function	Loads one entity. Overrides EntityStorageInterface::load	2
EntityStorageBase::loadByProperties	public	function	Load entities by their property values. Overrides EntityStorageInterface::loadByProperties	3
EntityStorageBase::loadMultiple	public	function	Loads one or more entities. Overrides EntityStorageInterface::loadMultiple	1
EntityStorageBase::loadUnchanged	public	function	Loads an unchanged entity from the database. Overrides EntityStorageInterface::loadUnchanged	1
EntityStorageBase::mapFromStorageRecords	protected	function	Maps from storage records to entity objects.	4
EntityStorageBase::postLoad	protected	function	Attaches data to entities upon loading.
EntityStorageBase::preLoad	protected	function	Gathers entities from a 'preload' step.	1
EntityStorageBase::resetCache	public	function	Resets the internal, static entity cache. Overrides EntityStorageInterface::resetCache	2
EntityStorageBase::restore	public	function	Restores a previously saved entity. Overrides EntityStorageInterface::restore	1
EntityStorageBase::setStaticCache	protected	function	Stores entities in the static entity cache.
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
ReactionRuleStorage::$drupalKernel	protected	property	The Drupal kernel.
ReactionRuleStorage::$eventManager	protected	property	The event manager.
ReactionRuleStorage::$stateService	protected	property	The state service.
ReactionRuleStorage::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides ConfigEntityStorage::createInstance
ReactionRuleStorage::delete	public	function	Deletes permanently saved entities. Overrides EntityStorageBase::delete
ReactionRuleStorage::getRegisteredEvents	protected	function	Returns a list of event names that are used by active reaction rules.
ReactionRuleStorage::save	public	function	Implements Drupal\Core\Entity\EntityStorageInterface::save(). Overrides ConfigEntityStorage::save
ReactionRuleStorage::__construct	public	function	Constructs a ReactionRuleStorage object. Overrides ConfigEntityStorage::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.