class EventSubscriber

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

Hierarchy

  • class \Drupal\config_events_test\EventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

Expanded class hierarchy of EventSubscriber

1 string reference to 'EventSubscriber'
config_events_test.services.yml in core/modules/config/tests/config_events_test/config_events_test.services.yml
core/modules/config/tests/config_events_test/config_events_test.services.yml
1 service uses EventSubscriber
config_events_test.event_subscriber in core/modules/config/tests/config_events_test/config_events_test.services.yml
Drupal\config_events_test\EventSubscriber

File

core/modules/config/tests/config_events_test/src/EventSubscriber.php, line 11

Namespace

Drupal\config_events_test
View source
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;
    }

}

Members

Title Sort descending Modifiers Object type Summary
EventSubscriber::$state protected property The state key value store.
EventSubscriber::configEventRecorder public function Reacts to config event.
EventSubscriber::getSubscribedEvents public static function
EventSubscriber::__construct public function Constructs the Event Subscriber object.

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