class TwigPhpStorageCache

Same name in other branches
  1. 9 core/lib/Drupal/Core/Template/TwigPhpStorageCache.php \Drupal\Core\Template\TwigPhpStorageCache
  2. 8.9.x core/lib/Drupal/Core/Template/TwigPhpStorageCache.php \Drupal\Core\Template\TwigPhpStorageCache
  3. 11.x core/lib/Drupal/Core/Template/TwigPhpStorageCache.php \Drupal\Core\Template\TwigPhpStorageCache

Provides an alternate cache storage for Twig using PhpStorage.

This class is designed to work on setups with multiple web heads using a local filesystem for the twig cache. When generating the cache key, a hash value depending on the enabled extensions is included. This prevents stale templates from being reused when twig extensions are enabled or disabled.

Hierarchy

Expanded class hierarchy of TwigPhpStorageCache

See also

\Drupal\Core\DependencyInjection\Compiler\TwigExtensionPass

1 file declares its use of TwigPhpStorageCache
TwigEnvironmentTest.php in core/tests/Drupal/KernelTests/Core/Theme/TwigEnvironmentTest.php

File

core/lib/Drupal/Core/Template/TwigPhpStorageCache.php, line 20

Namespace

Drupal\Core\Template
View source
class TwigPhpStorageCache implements CacheInterface {
    
    /**
     * The maximum length for each part of the cache key suffix.
     */
    const SUFFIX_SUBSTRING_LENGTH = 25;
    
    /**
     * The cache object used for auto-refresh via mtime.
     *
     * @var \Drupal\Core\Cache\CacheBackendInterface
     */
    protected $cache;
    
    /**
     * The PhpStorage object used for storing the templates.
     *
     * @var \Drupal\Component\PhpStorage\PhpStorageInterface
     */
    protected $storage;
    
    /**
     * The template cache filename prefix.
     *
     * @var string
     */
    protected $templateCacheFilenamePrefix;
    
    /**
     * Store cache backend and other information internally.
     *
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache
     *   The cache bin.
     * @param string $twig_cache_prefix
     *   A Twig cache file prefix that changes when Twig extensions change.
     */
    public function __construct(CacheBackendInterface $cache, $twig_cache_prefix) {
        $this->cache = $cache;
        $this->templateCacheFilenamePrefix = $twig_cache_prefix;
    }
    
    /**
     * Gets the PHP code storage object to use for the compiled Twig files.
     *
     * @return \Drupal\Component\PhpStorage\PhpStorageInterface
     */
    protected function storage() {
        if (!isset($this->storage)) {
            $this->storage = PhpStorageFactory::get('twig');
        }
        return $this->storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public function generateKey(string $name, string $className) : string {
        if (str_starts_with($name, '{# inline_template_start #}')) {
            // $name is an inline template, and can have characters that are not valid
            // for a filename. $suffix is unique for each inline template so we just
            // use the generic name 'inline-template' here.
            $name = 'inline-template';
        }
        else {
            $name = basename($name);
        }
        // Windows (and some encrypted Linux systems) only support 255 characters in
        // a path. On Windows a requirements error is displayed and installation is
        // blocked if Drupal's public files path is longer than 120 characters.
        // Thus, to always be less than 255, file paths may not be more than 135
        // characters long. Using the default PHP file storage class, the Twig cache
        // file path will be 124 characters long at most, which provides a margin of
        // safety.
        $suffix = substr($name, 0, self::SUFFIX_SUBSTRING_LENGTH) . '_';
        $suffix .= substr(Crypt::hashBase64($className), 0, self::SUFFIX_SUBSTRING_LENGTH);
        // The cache prefix is what gets invalidated.
        return $this->templateCacheFilenamePrefix . '_' . $suffix;
    }
    
    /**
     * {@inheritdoc}
     */
    public function load(string $key) : void {
        $this->storage()
            ->load($key);
    }
    
    /**
     * {@inheritdoc}
     */
    public function write(string $key, string $content) : void {
        $this->storage()
            ->save($key, $content);
        // Save the last mtime.
        $cid = 'twig:' . $key;
        $this->cache
            ->set($cid, \Drupal::time()->getRequestTime());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTimestamp(string $key) : int {
        $cid = 'twig:' . $key;
        if ($cache = $this->cache
            ->get($cid)) {
            return $cache->data;
        }
        else {
            return 0;
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary
TwigPhpStorageCache::$cache protected property The cache object used for auto-refresh via mtime.
TwigPhpStorageCache::$storage protected property The PhpStorage object used for storing the templates.
TwigPhpStorageCache::$templateCacheFilenamePrefix protected property The template cache filename prefix.
TwigPhpStorageCache::generateKey public function
TwigPhpStorageCache::getTimestamp public function
TwigPhpStorageCache::load public function
TwigPhpStorageCache::storage protected function Gets the PHP code storage object to use for the compiled Twig files.
TwigPhpStorageCache::SUFFIX_SUBSTRING_LENGTH constant The maximum length for each part of the cache key suffix.
TwigPhpStorageCache::write public function
TwigPhpStorageCache::__construct public function Store cache backend and other information internally.

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