vendor/pimcore/pimcore/lib/Twig/Extension/CacheExtension.php line 153

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Twig\Extension;
  18. use Pimcore\Cache as CacheManager;
  19. use Pimcore\Http\Request\Resolver\EditmodeResolver;
  20. use Twig\Extension\AbstractExtension;
  21. use Twig\TwigFunction;
  23. /**
  24.  * @internal
  25.  */
  26. class CacheExtension extends AbstractExtension
  27. {
  28.     /**
  29.      * @var string
  30.      */
  31.     protected $key;
  33.     /**
  34.      * @var bool[]
  35.      */
  36.     protected $captureEnabled = [];
  38.     /**
  39.      * @var bool
  40.      */
  41.     protected $force = false;
  43.     /**
  44.      * @var int
  45.      */
  46.     protected $lifetime;
  48.     /**
  49.      * @var EditmodeResolver
  50.      */
  51.     protected $editmodeResolver;
  53.     public function __construct(EditmodeResolver $editmodeResolver)
  54.     {
  55.         $this->editmodeResolver = $editmodeResolver;
  56.     }
  58.     public function getFunctions(): array
  59.     {
  60.         return [
  61.             new TwigFunction('pimcore_cache', [$this, 'init'], ['is_safe' => ['html']]),
  62.         ];
  63.     }
  65.     /**
  66.      * @param string $name
  67.      * @param int|null $lifetime
  68.      * @param bool $force
  69.      *
  70.      * @return $this
  71.      */
  72.     public function init($name, $lifetime = null, $force = false)
  73.     {
  74.         $this->key = 'pimcore_viewcache_' . $name;
  75.         $this->force = $force;
  77.         if (!$lifetime) {
  78.             $lifetime = null;
  79.         }
  81.         $this->lifetime = $lifetime;
  83.         return $this;
  84.     }
  86.     /**
  87.      * @return bool
  88.      */
  89.     public function start()
  90.     {
  91.         if (\Pimcore\Tool::isFrontendRequestByAdmin() && !$this->force) {
  92.             return false;
  93.         }
  95.         if ($content = CacheManager::load($this->key)) {
  96.             $this->outputContent($content, $this->key, true);
  98.             return true;
  99.         }
  101.         $this->captureEnabled[$this->key] = true;
  102.         ob_start();
  104.         return false;
  105.     }
  107.     /**
  108.      *  @return void
  109.      */
  110.     public function end()
  111.     {
  112.         if ($this->captureEnabled[$this->key] ?? false) {
  113.             $this->captureEnabled[$this->key] = false;
  115.             $tags = ['in_template'];
  116.             if (!$this->lifetime) {
  117.                 $tags[] = 'output';
  118.             }
  120.             $content = ob_get_clean();
  121.             $this->saveContentToCache($content, $this->key, $tags);
  122.             $this->outputContent($content, $this->key, false);
  123.         }
  124.     }
  126.     /**
  127.      *  @return void
  128.      */
  129.     public function stop()
  130.     {
  131.         $this->end();
  132.     }
  134.     /**
  135.      * Output the content.
  136.      *
  137.      * @param string $content the content, either rendered or retrieved directly from the cache.
  138.      * @param string $key the cache key
  139.      * @param bool $isLoadedFromCache true if the content origins from the cache and hasn't been created "live".
  140.      */
  141.     protected function outputContent($content, string $key, bool $isLoadedFromCache)
  142.     {
  143.         echo $content;
  144.     }
  146.     /**
  147.      * Save the (rendered) content to to cache. May be overriden to add custom markup / code, or specific tags, etc.
  148.      *
  149.      * @param string $content
  150.      * @param string $key
  151.      * @param array $tags
  152.      */
  153.     protected function saveContentToCache($content, string $key, array $tags)
  154.     {
  155.         CacheManager::save($content, $key, $tags, $this->lifetime, 996, true);
  156.     }
  157. }