class ConfigCacheTag

Same name and namespace in other branches
  1. 9 core/modules/system/src/EventSubscriber/ConfigCacheTag.php \Drupal\system\EventSubscriber\ConfigCacheTag
  2. 8.9.x core/modules/system/src/EventSubscriber/ConfigCacheTag.php \Drupal\system\EventSubscriber\ConfigCacheTag
  3. 10 core/modules/system/src/EventSubscriber/ConfigCacheTag.php \Drupal\system\EventSubscriber\ConfigCacheTag

A subscriber invalidating cache tags when system config objects are saved.

Hierarchy

  • class \Drupal\system\EventSubscriber\ConfigCacheTag extends \Symfony\Component\EventDispatcher\EventSubscriberInterface

Expanded class hierarchy of ConfigCacheTag

1 string reference to 'ConfigCacheTag'
system.services.yml in core/modules/system/system.services.yml
core/modules/system/system.services.yml
1 service uses ConfigCacheTag
system.config_cache_tag in core/modules/system/system.services.yml
Drupal\system\EventSubscriber\ConfigCacheTag

File

core/modules/system/src/EventSubscriber/ConfigCacheTag.php, line 15

Namespace

Drupal\system\EventSubscriber
View source
class ConfigCacheTag implements EventSubscriberInterface {
  
  /**
   * Constructs a ConfigCacheTag object.
   */
  public function __construct(protected ThemeHandlerInterface $themeHandler, protected CacheTagsInvalidatorInterface $cacheTagsInvalidator, protected Registry $themeRegistry) {
  }
  
  /**
   * Invalidate cache tags when particular system config objects are saved.
   *
   * @param \Drupal\Core\Config\ConfigCrudEvent $event
   *   The Event to process.
   */
  public function onSave(ConfigCrudEvent $event) {
    $config_name = $event->getConfig()
      ->getName();
    // Changing the site settings may mean a different route is selected for the
    // front page. Additionally a change to the site name or similar must
    // invalidate the render cache since this could be used anywhere.
    if ($config_name === 'system.site') {
      $this->cacheTagsInvalidator
        ->invalidateTags([
        'route_match',
        'rendered',
      ]);
    }
    // Theme configuration and global theme settings.
    if (in_array($config_name, [
      'system.theme',
      'system.theme.global',
    ], TRUE)) {
      $this->cacheTagsInvalidator
        ->invalidateTags([
        'rendered',
      ]);
    }
    // Library and template overrides potentially change for the default theme
    // when the admin theme is changed.
    if ($config_name === 'system.theme' && $event->isChanged('admin')) {
      $this->themeRegistry
        ->reset();
      $this->cacheTagsInvalidator
        ->invalidateTags([
        'library_info',
      ]);
    }
    // Theme-specific settings, check if this matches a theme settings
    // configuration object (THEME_NAME.settings), in that case, clear the
    // rendered cache tag.
    if (preg_match('/^([^\\.]*)\\.settings$/', $config_name, $matches)) {
      if ($this->themeHandler
        ->themeExists($matches[1])) {
        $this->cacheTagsInvalidator
          ->invalidateTags([
          'rendered',
        ]);
      }
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() : array {
    $events[ConfigEvents::SAVE][] = [
      'onSave',
    ];
    return $events;
  }

}

Members

Title Sort descending Modifiers Object type Summary
ConfigCacheTag::getSubscribedEvents public static function
ConfigCacheTag::onSave public function Invalidate cache tags when particular system config objects are saved.
ConfigCacheTag::__construct public function Constructs a ConfigCacheTag object.

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