class ConfigRenameEvent

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/ConfigRenameEvent.php \Drupal\Core\Config\ConfigRenameEvent
  2. 8.9.x core/lib/Drupal/Core/Config/ConfigRenameEvent.php \Drupal\Core\Config\ConfigRenameEvent
  3. 10 core/lib/Drupal/Core/Config/ConfigRenameEvent.php \Drupal\Core\Config\ConfigRenameEvent

Configuration event fired when renaming a configuration object.

Hierarchy

  • class \Drupal\Component\EventDispatcher\Event extends \Symfony\Contracts\EventDispatcher\Event
    • class \Drupal\Core\Config\ConfigCrudEvent extends \Drupal\Component\EventDispatcher\Event
      • class \Drupal\Core\Config\ConfigRenameEvent extends \Drupal\Core\Config\ConfigCrudEvent

Expanded class hierarchy of ConfigRenameEvent

3 files declare their use of ConfigRenameEvent
CheckpointStorage.php in core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorage.php
ConfigFactoryOverrideBaseTest.php in core/tests/Drupal/Tests/Core/Config/ConfigFactoryOverrideBaseTest.php
LanguageConfigFactoryOverride.php in core/modules/language/src/Config/LanguageConfigFactoryOverride.php

File

core/lib/Drupal/Core/Config/ConfigRenameEvent.php, line 8

Namespace

Drupal\Core\Config
View source 
class ConfigRenameEvent extends ConfigCrudEvent {
    
    /**
     * The old configuration object name.
     *
     * @var string
     */
    protected $oldName;
    
    /**
     * Constructs the config rename event.
     *
     * @param \Drupal\Core\Config\StorableConfigBase $config
     *   The configuration that has been renamed.
     * @param string $old_name
     *   The old configuration object name.
     */
    public function __construct(StorableConfigBase $config, $old_name) {
        $this->config = $config;
        $this->oldName = $old_name;
    }
    
    /**
     * Gets the old configuration object name.
     *
     * @return string
     *   The old configuration object name.
     */
    public function getOldName() {
        return $this->oldName;
    }

}

Members

Title Modifiers Object type Summary Overriden Title
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.
ConfigRenameEvent::$oldName protected property The old configuration object name.
ConfigRenameEvent::getOldName public function Gets the old configuration object name.
ConfigRenameEvent::__construct public function Constructs the config rename event. Overrides ConfigCrudEvent::__construct

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