EventSubscriber.php

Same filename in this branch
  1. 11.x core/modules/language/tests/language_events_test/src/EventSubscriber.php
  2. 11.x core/modules/config/tests/config_collection_install_test/src/EventSubscriber.php
  3. 11.x core/modules/config/tests/config_transformer_test/src/EventSubscriber.php
  4. 11.x core/modules/config/tests/config_import_test/src/EventSubscriber.php
  5. 11.x core/modules/system/tests/modules/module_install_class_loader_test2/src/EventSubscriber.php
  6. 11.x core/modules/system/tests/modules/module_install_class_loader_test1/src/EventSubscriber.php
Same filename and directory in other branches
  1. 9 core/modules/config/tests/config_collection_install_test/src/EventSubscriber.php
  2. 9 core/modules/config/tests/config_events_test/src/EventSubscriber.php
  3. 9 core/modules/config/tests/config_transformer_test/src/EventSubscriber.php
  4. 9 core/modules/config/tests/config_import_test/src/EventSubscriber.php
  5. 9 core/modules/system/tests/modules/module_install_class_loader_test2/src/EventSubscriber.php
  6. 9 core/modules/system/tests/modules/module_install_class_loader_test1/src/EventSubscriber.php
  7. 8.9.x core/modules/config/tests/config_collection_install_test/src/EventSubscriber.php
  8. 8.9.x core/modules/config/tests/config_events_test/src/EventSubscriber.php
  9. 8.9.x core/modules/config/tests/config_transformer_test/src/EventSubscriber.php
  10. 8.9.x core/modules/config/tests/config_import_test/src/EventSubscriber.php
  11. 8.9.x core/modules/system/tests/modules/module_install_class_loader_test2/src/EventSubscriber.php
  12. 8.9.x core/modules/system/tests/modules/module_install_class_loader_test1/src/EventSubscriber.php
  13. 10 core/modules/language/tests/language_events_test/src/EventSubscriber.php
  14. 10 core/modules/config/tests/config_collection_install_test/src/EventSubscriber.php
  15. 10 core/modules/config/tests/config_events_test/src/EventSubscriber.php
  16. 10 core/modules/config/tests/config_transformer_test/src/EventSubscriber.php
  17. 10 core/modules/config/tests/config_import_test/src/EventSubscriber.php
  18. 10 core/modules/system/tests/modules/module_install_class_loader_test2/src/EventSubscriber.php
  19. 10 core/modules/system/tests/modules/module_install_class_loader_test1/src/EventSubscriber.php

Namespace

Drupal\config_events_test

File

core/modules/config/tests/config_events_test/src/EventSubscriber.php

View source
<?php

declare (strict_types=1);
namespace Drupal\config_events_test;

use Drupal\Core\Config\ConfigCollectionEvents;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
use Drupal\Core\State\StateInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Event subscriber for testing configuration events.
 */
class EventSubscriber implements EventSubscriberInterface {
  
  /**
   * The state key value store.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;
  
  /**
   * Constructs the Event Subscriber object.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   The state key value store.
   */
  public function __construct(StateInterface $state) {
    $this->state = $state;
  }
  
  /**
   * Reacts to config event.
   *
   * @param \Drupal\Core\Config\ConfigCrudEvent $event
   *   The configuration event.
   * @param string $event_name
   *   The event name.
   */
  public function configEventRecorder(ConfigCrudEvent $event, $event_name) {
    $config = $event->getConfig();
    $event_info = [
      'event_name' => $event_name,
      'current_config_data' => $config->get(),
      'original_config_data' => $config->getOriginal(),
      'raw_config_data' => $config->getRawData(),
    ];
    $this->state
      ->set('config_events_test.event', $event_info);
    // Record all events that occur.
    $all_events = $this->state
      ->get('config_events_test.all_events', []);
    $config_name = $config->getName();
    $all_events[$event_name][$config_name][] = $event_info;
    $this->state
      ->set('config_events_test.all_events', $all_events);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() : array {
    $events[ConfigEvents::SAVE][] = [
      'configEventRecorder',
    ];
    $events[ConfigEvents::DELETE][] = [
      'configEventRecorder',
    ];
    $events[ConfigEvents::RENAME][] = [
      'configEventRecorder',
    ];
    $events[ConfigCollectionEvents::SAVE_IN_COLLECTION][] = [
      'configEventRecorder',
    ];
    $events[ConfigCollectionEvents::DELETE_IN_COLLECTION][] = [
      'configEventRecorder',
    ];
    $events[ConfigCollectionEvents::RENAME_IN_COLLECTION][] = [
      'configEventRecorder',
    ];
    return $events;
  }

}

Classes

Title Deprecated Summary
EventSubscriber Event subscriber for testing configuration events.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.