ConfigCrudEvent.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Config/ConfigCrudEvent.php
  2. 10 core/lib/Drupal/Core/Config/ConfigCrudEvent.php
  3. 11.x core/lib/Drupal/Core/Config/ConfigCrudEvent.php

Namespace

Drupal\Core\Config

File

core/lib/Drupal/Core/Config/ConfigCrudEvent.php

View source
<?php

namespace Drupal\Core\Config;

use Symfony\Component\EventDispatcher\Event;

/**
 * Wraps a configuration event for event listeners.
 */
class ConfigCrudEvent extends Event {
    
    /**
     * Configuration object.
     *
     * @var \Drupal\Core\Config\Config
     */
    protected $config;
    
    /**
     * Constructs a configuration event object.
     *
     * @param \Drupal\Core\Config\Config $config
     *   Configuration object.
     */
    public function __construct(Config $config) {
        $this->config = $config;
    }
    
    /**
     * Gets configuration object.
     *
     * @return \Drupal\Core\Config\Config
     *   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);
    }

}

Classes

Title Deprecated Summary
ConfigCrudEvent Wraps a configuration event for event listeners.

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