vendor/shopware/core/Checkout/Payment/SalesChannel/CachedPaymentMethodRoute.php line 96

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Payment\SalesChannel;
  5. use Shopware\Core\Checkout\Payment\Event\PaymentMethodRouteCacheKeyEvent;
  6. use Shopware\Core\Checkout\Payment\Event\PaymentMethodRouteCacheTagsEvent;
  7. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  8. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  10. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  12. use Shopware\Core\Framework\Routing\Annotation\Entity;
  13. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  14. use Shopware\Core\Framework\Routing\Annotation\Since;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  16. use Shopware\Core\System\SalesChannel\StoreApiResponse;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\Routing\Annotation\Route;
  19. use Symfony\Contracts\Cache\CacheInterface;
  20. use Symfony\Contracts\Cache\ItemInterface;
  21. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  23. /**
  24.  * @Route(defaults={"_routeScope"={"store-api"}})
  25.  */
  26. class CachedPaymentMethodRoute extends AbstractPaymentMethodRoute
  27. {
  28.     public const ALL_TAG = 'payment-method-route';
  30.     private AbstractPaymentMethodRoute $decorated;
  32.     private CacheInterface $cache;
  34.     private EntityCacheKeyGenerator $generator;
  36.     /**
  37.      * @var AbstractCacheTracer<PaymentMethodRouteResponse>
  38.      */
  39.     private AbstractCacheTracer $tracer;
  41.     /**
  42.      * @var array<string>
  43.      */
  44.     private array $states;
  46.     private EventDispatcherInterface $dispatcher;
  48.     /**
  49.      * @internal
  50.      *
  51.      * @param AbstractCacheTracer<PaymentMethodRouteResponse> $tracer
  52.      * @param array<string> $states
  53.      */
  54.     public function __construct(
  55.         AbstractPaymentMethodRoute $decorated,
  56.         CacheInterface $cache,
  57.         EntityCacheKeyGenerator $generator,
  58.         AbstractCacheTracer $tracer,
  59.         EventDispatcherInterface $dispatcher,
  60.         array $states
  61.     ) {
  62.         $this->decorated = $decorated;
  63.         $this->cache = $cache;
  64.         $this->generator = $generator;
  65.         $this->tracer = $tracer;
  66.         $this->states = $states;
  67.         $this->dispatcher = $dispatcher;
  68.     }
  70.     public function getDecorated(): AbstractPaymentMethodRoute
  71.     {
  72.         return $this->decorated;
  73.     }
  75.     /**
  76.      * @Since("6.2.0.0")
  77.      * @Entity("payment_method")
  78.      * @Route("/store-api/payment-method", name="store-api.payment.method", methods={"GET", "POST"})
  79.      */
  80.     public function load(Request $request, SalesChannelContext $context, Criteria $criteria): PaymentMethodRouteResponse
  81.     {
  82.         if ($context->hasState(...$this->states)) {
  83.             return $this->getDecorated()->load($request, $context, $criteria);
  84.         }
  86.         $key = $this->generateKey($request, $context, $criteria);
  88.         if ($key === null) {
  89.             return $this->getDecorated()->load($request, $context, $criteria);
  90.         }
  92.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context, $criteria) {
  93.             $name = self::buildName($context->getSalesChannelId());
  95.             $response = $this->tracer->trace($name, function () use ($request, $context, $criteria) {
  96.                 return $this->getDecorated()->load($request, $context, $criteria);
  97.             });
  99.             $item->tag($this->generateTags($request, $response, $context, $criteria));
  101.             return CacheValueCompressor::compress($response);
  102.         });
  104.         return CacheValueCompressor::uncompress($value);
  105.     }
  107.     public static function buildName(string $salesChannelId): string
  108.     {
  109.         return 'payment-method-route-' . $salesChannelId;
  110.     }
  112.     private function generateKey(Request $request, SalesChannelContext $context, Criteria $criteria): ?string
  113.     {
  114.         $parts = [
  115.             $this->generator->getCriteriaHash($criteria),
  116.             $this->generator->getSalesChannelContextHash($context),
  117.             $request->query->getBoolean('onlyAvailable', false),
  118.         ];
  120.         $event = new PaymentMethodRouteCacheKeyEvent($parts, $request, $context, $criteria);
  121.         $this->dispatcher->dispatch($event);
  123.         if (!$event->shouldCache()) {
  124.             return null;
  125.         }
  127.         return self::buildName($context->getSalesChannelId()) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  128.     }
  130.     /**
  131.      * @return array<string>
  132.      */
  133.     private function generateTags(Request $request, StoreApiResponse $response, SalesChannelContext $context, Criteria $criteria): array
  134.     {
  135.         $tags = array_merge(
  136.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  137.             [self::buildName($context->getSalesChannelId()), self::ALL_TAG]
  138.         );
  140.         $event = new PaymentMethodRouteCacheTagsEvent($tags, $request, $response, $context, $criteria);
  141.         $this->dispatcher->dispatch($event);
  143.         return array_unique(array_filter($event->getTags()));
  144.     }
  145. }