MovingImage\Bundle\VMProApiBundle\EventListener\BypassCacheListener

Complexity

Total Complexity

6

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	onKernelRequest()	0	13	4
A	getSubscribedEvents()	0	6	1

<?php

declare(strict_types=1);

namespace MovingImage\Bundle\VMProApiBundle\EventListener;

use MovingImage\Bundle\VMProApiBundle\Decorator\BlackholeCacheItemPoolDecorator;
use MovingImage\Client\VMPro\ApiClient;
use MovingImage\Client\VMPro\ApiClient\AbstractApiClient;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;

/**
 * This listener kicks in only if the `cache_bypass_argument` bundle config option is set.
 * If the request contains an argument matching the value configured in the aforementioned config option
 * and the value of that argument evaluates to true, this listener will modify the cache pool implementation
 * used by the VMPro API client, by decorating it with a blackhole cache implementation:
 * one that stores responses to cache, but never returns a hit.
 */
class BypassCacheListener implements EventSubscriberInterface
{
    /**
     * @var ApiClient
     */
    private $apiClient;

    /**
     * @var string|null
     */
    private $cacheBypassArgument;

    public function __construct(ApiClient $apiClient, ?string $cacheBypassArgument = null)
    {
        $this->apiClient = $apiClient;
        $this->cacheBypassArgument = $cacheBypassArgument;
    }

    public function onKernelRequest(GetResponseEvent $event): void
    {
        if (is_null($this->cacheBypassArgument)) {
            return;
        }

        $request = $event->getRequest();
        if ($request->get($this->cacheBypassArgument) || $request->cookies->get($this->cacheBypassArgument)) {
            /** @var AbstractApiClient $apiClient */
            $cachePool = new BlackholeCacheItemPoolDecorator($this->apiClient->getCacheItemPool());
            $this->apiClient->setCacheItemPool($cachePool);
        }
    }

    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::REQUEST => 'onKernelRequest',
        ];
    }
}