ColorConfigCacheInvalidator.php

Same filename in other branches
  1. 8.9.x core/modules/color/src/EventSubscriber/ColorConfigCacheInvalidator.php

Namespace

Drupal\color\EventSubscriber

File

core/modules/color/src/EventSubscriber/ColorConfigCacheInvalidator.php

View source
<?php

namespace Drupal\color\EventSubscriber;

use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * A subscriber invalidating cache tags when color config objects are saved.
 */
class ColorConfigCacheInvalidator implements EventSubscriberInterface {
    
    /**
     * The cache tags invalidator.
     *
     * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
     */
    protected $cacheTagsInvalidator;
    
    /**
     * Constructs a ColorConfigCacheInvalidator object.
     *
     * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_tags_invalidator
     *   The cache tags invalidator.
     */
    public function __construct(CacheTagsInvalidatorInterface $cache_tags_invalidator) {
        $this->cacheTagsInvalidator = $cache_tags_invalidator;
    }
    
    /**
     * Invalidate cache tags when a color theme config object changes.
     *
     * @param \Drupal\Core\Config\ConfigCrudEvent $event
     *   The Event to process.
     */
    public function onChange(ConfigCrudEvent $event) {
        // Changing a theme's color settings causes the theme's asset library
        // containing the color CSS file to be altered to use a different file.
        if (strpos($event->getConfig()
            ->getName(), 'color.theme.') === 0) {
            $this->cacheTagsInvalidator
                ->invalidateTags([
                'library_info',
            ]);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() {
        $events[ConfigEvents::SAVE][] = [
            'onChange',
        ];
        $events[ConfigEvents::DELETE][] = [
            'onChange',
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
ColorConfigCacheInvalidator A subscriber invalidating cache tags when color config objects are saved.

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