vendor/store.shopware.com/netzpblog6/src/Controller/StoreApi/BlogListing/CachedBlogListingRoute.php line 103

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace NetzpBlog6\Controller\StoreApi\BlogListing;
  5. use OpenApi\Annotations as OA;
  6. use Shopware\Core\Framework\Routing\Annotation\Entity;
  7. use Symfony\Component\Routing\Annotation\Route;
  8. use Psr\Log\LoggerInterface;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  11. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  12. use Shopware\Core\Framework\Adapter\Cache\CacheCompressor;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  14. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  15. use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
  17. class CachedBlogListingRoute extends AbstractBlogListingRoute
  18. {
  19.     private AbstractBlogListingRoute $decorated;
  21.     private TagAwareAdapterInterface $cache;
  23.     private EntityCacheKeyGenerator $generator;
  25.     private AbstractCacheTracer $tracer;
  27.     private array $states;
  29.     private LoggerInterface $logger;
  31.     public function __construct(
  32.         AbstractBlogListingRoute $decorated,
  33.         TagAwareAdapterInterface $cache,
  34.         EntityCacheKeyGenerator $generator,
  35.         AbstractCacheTracer $tracer,
  36.         LoggerInterface $logger
  37.     ) {
  38.         $this->decorated = $decorated;
  39.         $this->cache = $cache;
  40.         $this->generator = $generator;
  41.         $this->tracer = $tracer;
  42.         $this->states = [];
  43.         $this->logger = $logger;
  44.     }
  46.     public function getDecorated(): AbstractBlogListingRoute
  47.     {
  48.         return $this->decorated;
  49.     }
  51.     /**
  52.      * @Entity("s_plugin_netzp_blog")
  53.      * @OA\Post(
  54.      *      path="/bloglisting",
  55.      *      summary="This route can be used to load a blog listing",
  56.      *      operationId="readNetzpBlogListing",
  57.      *      tags={"Store API", "NetzpBlog"},
  58.      *      @OA\Parameter(name="Api-Basic-Parameters"),
  59.      *      @OA\Response(
  60.      *          response="200",
  61.      *          description="",
  62.      *          @OA\JsonContent(type="object",
  63.      *              @OA\Property(
  64.      *                  property="total",
  65.      *                  type="integer",
  66.      *                  description="Total amount"
  67.      *              ),
  68.      *              @OA\Property(
  69.      *                  property="aggregations",
  70.      *                  type="object",
  71.      *                  description="aggregation result"
  72.      *              )
  73.      *          )
  74.      *     )
  75.      * )
  76.      * @Route("/store-api/bloglisting/{navigationId?}", name="store-api.s_plugin_netzp_blog_listing.load", methods={"GET", "POST"}, defaults={"_routeScope"={"store-api"}})
  77.      */
  78.     public function load($navigationId, Criteria $criteria, SalesChannelContext $context,
  79.         ?string $categoryId, ?string $authorId, ?array $tags, ?string $sortOrder): BlogListingRouteResponse
  80.     {
  81.         // The context is provided with a state where the route cannot be cached
  82.         if ($context->hasState(...$this->states)) {
  83.             return $this->getDecorated()->load($navigationId, $criteria, $context, $categoryId, $authorId, $tags, $sortOrder);
  84.         }
  86.         // Fetch item from the cache pool
  87.         $item = $this->cache->getItem(
  88.             $this->generateKey($navigationId, $context, $criteria)
  89.         );
  91.         try {
  92.             if ($item->isHit() && $item->get()) {
  93.                 // Use cache compressor to uncompress the cache value
  94.                 return CacheCompressor::uncompress($item);
  95.             }
  96.         } catch (\Throwable $e) {
  97.             // Something went wrong when uncompress the cache item - we log the error and continue to overwrite the invalid cache item
  98.             $this->logger->error($e->getMessage());
  99.         }
  101.         $name = self::buildName($navigationId);
  102.         // start tracing of nested cache tags and system config keys
  103.         $response = $this->tracer->trace($name, function () use ($navigationId, $criteria, $context, $categoryId, $authorId, $tags, $sortOrder) {
  104.             return $this->getDecorated()->load($navigationId, $criteria, $context, $categoryId, $authorId, $tags, $sortOrder);
  105.         });
  107.         // compress cache content to reduce cache size
  108.         $item = CacheCompressor::compress($item, $response);
  110.         $item->tag(array_merge(
  111.         // get traced tags and configs
  112.             $this->tracer->get(self::buildName($navigationId)),
  113.             [self::buildName($navigationId), self::buildName('')]
  114.         ));
  116.         $this->cache->save($item);
  118.         return $response;
  119.     }
  121.     public static function buildName($navigationId): string
  122.     {
  123.         return 'blog-listing-route-' . $navigationId;
  124.     }
  126.     private function generateKey($navigationId, SalesChannelContext $context, Criteria $criteria): string
  127.     {
  128.         $parts = [
  129.             self::buildName($navigationId),
  130.             // generate a hash for the route criteria
  131.             $this->generator->getCriteriaHash($criteria),
  132.             // generate a hash for the current context
  133.             $this->generator->getSalesChannelContextHash($context),
  134.         ];
  136.         return md5(JsonFieldSerializer::encodeJson($parts));
  137.     }
  138. }