class ConfigCrudEvent

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Config/ConfigCrudEvent.php \Drupal\Core\Config\ConfigCrudEvent
  2. 8.9.x core/lib/Drupal/Core/Config/ConfigCrudEvent.php \Drupal\Core\Config\ConfigCrudEvent
  3. 11.x core/lib/Drupal/Core/Config/ConfigCrudEvent.php \Drupal\Core\Config\ConfigCrudEvent

Wraps a configuration event for event listeners.

Hierarchy

Expanded class hierarchy of ConfigCrudEvent

22 files declare their use of ConfigCrudEvent
AdvisoriesConfigSubscriber.php in core/modules/system/src/EventSubscriber/AdvisoriesConfigSubscriber.php
CheckpointStorage.php in core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorage.php
CheckpointStorageTest.php in core/tests/Drupal/Tests/Core/Config/Checkpoint/CheckpointStorageTest.php
CKEditor5CacheTag.php in core/modules/ckeditor5/src/EventSubscriber/CKEditor5CacheTag.php
ConfigCacheTag.php in core/modules/system/src/EventSubscriber/ConfigCacheTag.php

... See full list

File

core/lib/Drupal/Core/Config/ConfigCrudEvent.php, line 10

Namespace

Drupal\Core\Config
View source
class ConfigCrudEvent extends Event {
  
  /**
   * Configuration object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;
  
  /**
   * Constructs a configuration event object.
   *
   * @param \Drupal\Core\Config\StorableConfigBase $config
   *   Configuration object.
   */
  public function __construct(StorableConfigBase $config) {
    $this->config = $config;
  }
  
  /**
   * Gets configuration object.
   *
   * @return \Drupal\Core\Config\StorableConfigBase
   *   The configuration object that caused the event to fire.
   */
  public function getConfig() {
    return $this->config;
  }
  
  /**
   * Checks to see if the provided configuration key's value has changed.
   *
   * @param string $key
   *   The configuration key to check if it has changed.
   *
   * @return bool
   */
  public function isChanged($key) {
    return $this->config
      ->get($key) !== $this->config
      ->getOriginal($key);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ConfigCrudEvent::$config protected property Configuration object.
ConfigCrudEvent::getConfig public function Gets configuration object.
ConfigCrudEvent::isChanged public function Checks to see if the provided configuration key's value has changed.
ConfigCrudEvent::__construct public function Constructs a configuration event object. 1

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