class CacheTagsInvalidator

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

Passes cache tag events to classes that wish to respond to them.

Hierarchy

  • class \Drupal\Core\Cache\CacheTagsInvalidator implements \Drupal\Core\Cache\CacheTagsInvalidatorInterface

Expanded class hierarchy of CacheTagsInvalidator

1 file declares its use of CacheTagsInvalidator
CacheTagsInvalidatorTest.php in core/tests/Drupal/Tests/Core/Cache/CacheTagsInvalidatorTest.php
1 string reference to 'CacheTagsInvalidator'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses CacheTagsInvalidator
cache_tags.invalidator in core/core.services.yml
Drupal\Core\Cache\CacheTagsInvalidator

File

core/lib/Drupal/Core/Cache/CacheTagsInvalidator.php, line 10

Namespace

Drupal\Core\Cache
View source
class CacheTagsInvalidator implements CacheTagsInvalidatorInterface {
    
    /**
     * Holds an array of cache tags invalidators.
     *
     * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface[]
     */
    protected $invalidators = [];
    
    /**
     * Holds an array of cache bins that support invalidations.
     *
     * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface[]
     */
    protected array $bins = [];
    
    /**
     * {@inheritdoc}
     */
    public function invalidateTags(array $tags) {
        assert(Inspector::assertAllStrings($tags), 'Cache tags must be strings.');
        // Notify all added cache tags invalidators.
        foreach ($this->invalidators as $invalidator) {
            $invalidator->invalidateTags($tags);
        }
        // Additionally, notify each cache bin if it implements the service.
        foreach ($this->bins as $bin) {
            $bin->invalidateTags($tags);
        }
    }
    
    /**
     * Reset statically cached tags in all cache tag checksum services.
     *
     * This is only used by tests.
     */
    public function resetChecksums() {
        foreach ($this->invalidators as $invalidator) {
            if ($invalidator instanceof CacheTagsChecksumInterface) {
                $invalidator->reset();
            }
        }
    }
    
    /**
     * Adds a cache tags invalidator.
     *
     * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $invalidator
     *   A cache invalidator.
     */
    public function addInvalidator(CacheTagsInvalidatorInterface $invalidator) {
        $this->invalidators[] = $invalidator;
    }
    
    /**
     * Adds a cache bin.
     *
     * @param \Drupal\Core\Cache\CacheBackendInterface $bin
     *   A cache bin.
     */
    public function addBin(CacheBackendInterface $bin) : void {
        if ($bin instanceof CacheTagsInvalidatorInterface) {
            $this->bins[] = $bin;
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary
CacheTagsInvalidator::$bins protected property Holds an array of cache bins that support invalidations.
CacheTagsInvalidator::$invalidators protected property Holds an array of cache tags invalidators.
CacheTagsInvalidator::addBin public function Adds a cache bin.
CacheTagsInvalidator::addInvalidator public function Adds a cache tags invalidator.
CacheTagsInvalidator::invalidateTags public function
CacheTagsInvalidator::resetChecksums public function Reset statically cached tags in all cache tag checksum services.

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