custom/plugins/SasBlogModule/src/Controller/CachedBlogController.php line 63

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Sas\BlogModule\Controller;
  5. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  6. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  8. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  9. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  10. use Shopware\Storefront\Controller\StorefrontController;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpFoundation\Response;
  13. use Symfony\Component\Routing\Annotation\Route;
  14. use Symfony\Contracts\Cache\CacheInterface;
  15. use Symfony\Contracts\Cache\ItemInterface;
  17. /**
  18.  * Handle Cache for BlogController
  19.  *
  20.  * @Route(defaults={"_routeScope"={"storefront"}})
  21.  */
  22. class CachedBlogController extends StorefrontController
  23. {
  24.     private BlogController $decorated;
  26.     private CacheInterface $cache;
  28.     private EntityCacheKeyGenerator $generator;
  30.     /**
  31.      * @var AbstractCacheTracer<Response>
  32.      */
  33.     private AbstractCacheTracer $tracer;
  35.     public function __construct(
  36.         BlogController $decorated,
  37.         CacheInterface $cache,
  38.         EntityCacheKeyGenerator $generator,
  39.         AbstractCacheTracer $tracer
  40.     ) {
  41.         $this->decorated = $decorated;
  42.         $this->cache = $cache;
  43.         $this->generator = $generator;
  44.         $this->tracer = $tracer;
  45.     }
  47.     public static function buildName(string $articleId): string
  48.     {
  49.         return 'sas-blog-detail-' . $articleId;
  50.     }
  52.     /**
  53.      * @Route("/sas_blog/{articleId}", name="sas.frontend.blog.detail", methods={"GET"})
  54.      */
  55.     public function detailAction(string $articleId, Request $request, SalesChannelContext $context): Response
  56.     {
  57.         $key = $this->generateKey($articleId, $context);
  59.         $value = $this->cache->get($key, function (ItemInterface $item) use ($articleId, $request, $context) {
  60.             $name = self::buildName($articleId);
  61.             $response = $this->tracer->trace($name, function () use ($articleId, $request, $context) {
  62.                 return $this->decorated->detailAction($articleId, $request, $context);
  63.             });
  65.             $item->tag($this->generateTags($articleId));
  67.             return CacheValueCompressor::compress($response);
  68.         });
  70.         return CacheValueCompressor::uncompress($value);
  71.     }
  73.     private function generateKey(string $articleId, SalesChannelContext $context): string
  74.     {
  75.         $parts = [
  76.             $this->generator->getSalesChannelContextHash($context),
  77.         ];
  79.         return self::buildName($articleId) . '-' . md5(JsonFieldSerializer::encodeJson($parts));
  80.     }
  82.     /**
  83.      * @return array<string>
  84.      */
  85.     private function generateTags(string $articleId): array
  86.     {
  87.         $tags = array_merge(
  88.             $this->tracer->get(self::buildName($articleId)),
  89.             [self::buildName($articleId)]
  90.         );
  92.         return array_unique(array_filter($tags));
  93.     }
  94. }