adjust for symfony 7

composer.json

@@ -21,7 +21,7 @@
         }
     ],
     "require": {
-        "php": "^7.2 || ^8.0",
+        "php": "^8.0",
         "symfony/event-dispatcher": "^4.3 || ^5.0 || ^6.0 || ^7.0",
         "symfony/options-resolver": "^4.3 || ^5.0 || ^6.0 || ^7.0",
         "php-http/client-implementation": "^1.0 || ^2.0",

src/SymfonyCache/AccessControlledListener.php

@@ -26,10 +26,7 @@
  */
 abstract class AccessControlledListener implements EventSubscriberInterface
 {
-    /**
-     * @var RequestMatcherInterface
-     */
-    private $clientMatcher;
+    private RequestMatcherInterface $clientMatcher;
 
     /**
      * When creating this event listener, you can configure a number of options.
@@ -57,7 +54,7 @@ public function __construct(array $options = [])
         if (!$clientMatcher) {
             $clientMatcher = class_exists(IpsRequestMatcher::class)
                 ? new IpsRequestMatcher($options['client_ips'] ?: '127.0.0.1')
-                : new RequestMatcher(null, null, null, $options['client_ips'] ?: '127.0.0.1')
+                : new RequestMatcher(null, null, null, $options['client_ips'] ?: '127.0.0.1') /* @phpstan-ignore-line for BC with Symfony < 6.2 */
             ;
         }
 

src/SymfonyCache/CacheEvent.php

@@ -23,25 +23,13 @@
  */
 class CacheEvent extends BaseEvent
 {
-    /**
-     * @var CacheInvalidation
-     */
-    private $kernel;
+    private CacheInvalidation $kernel;
 
-    /**
-     * @var Request
-     */
-    private $request;
+    private Request $request;
 
-    /**
-     * @var Response
-     */
-    private $response;
+    private ?Response $response;
 
-    /**
-     * @var int
-     */
-    private $requestType;
+    private int $requestType;
 
     /**
      * Make sure your $kernel implements CacheInvalidationInterface.
@@ -51,7 +39,7 @@ class CacheEvent extends BaseEvent
      * @param Response|null     $response    the response, if available
      * @param int               $requestType the request type (default HttpKernelInterface::MASTER_REQUEST)
      */
-    public function __construct(CacheInvalidation $kernel, Request $request, Response $response = null, $requestType = HttpKernelInterface::MASTER_REQUEST)
+    public function __construct(CacheInvalidation $kernel, Request $request, Response $response = null, int $requestType = HttpKernelInterface::MAIN_REQUEST)
     {
         $this->kernel = $kernel;
         $this->request = $request;
@@ -71,31 +59,25 @@ public function getKernel()
 
     /**
      * Get the request that is being processed.
-     *
-     * @return Request
      */
-    public function getRequest()
+    public function getRequest(): Request
     {
         return $this->request;
     }
 
     /**
-     * One of the constants HttpKernelInterface::MASTER_REQUEST or SUB_REQUEST.
-     *
-     * @return int
+     * One of the constants HttpKernelInterface::MAIN_REQUEST or SUB_REQUEST.
      */
-    public function getRequestType()
+    public function getRequestType(): int
     {
         return $this->requestType;
     }
 
     /**
      * Events that occur after the response is created provide the default response.
      * Event listeners can also set the response to make it available here.
-     *
-     * @return Response|null the response if one was set
      */
-    public function getResponse()
+    public function getResponse(): ?Response
     {
         return $this->response;
     }
@@ -105,7 +87,7 @@ public function getResponse()
      *
      * Setting a response stops propagation of the event to further event handlers.
      */
-    public function setResponse(Response $response)
+    public function setResponse(Response $response): void
     {
         $this->response = $response;
 

src/SymfonyCache/EventDispatchingHttpCache.php

@@ -40,17 +40,9 @@
  */
 trait EventDispatchingHttpCache
 {
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $eventDispatcher;
+    private ?EventDispatcherInterface $eventDispatcher = null;
 
-    /**
-     * Get event dispatcher.
-     *
-     * @return EventDispatcherInterface
-     */
-    public function getEventDispatcher()
+    public function getEventDispatcher(): EventDispatcherInterface
     {
         if (!$this->eventDispatcher) {
             $this->eventDispatcher = new EventDispatcher();
@@ -64,7 +56,7 @@ public function getEventDispatcher()
      *
      * @see EventDispatcherInterface::addSubscriber
      */
-    public function addSubscriber(EventSubscriberInterface $subscriber)
+    public function addSubscriber(EventSubscriberInterface $subscriber): void
     {
         $this->getEventDispatcher()->addSubscriber($subscriber);
     }
@@ -74,7 +66,7 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
      *
      * @see EventDispatcherInterface::addListener
      */
-    public function addListener($eventName, $listener, $priority = 0)
+    public function addListener($eventName, $listener, $priority = 0): void
     {
         $this->getEventDispatcher()->addListener($eventName, $listener, $priority);
     }
@@ -84,7 +76,7 @@ public function addListener($eventName, $listener, $priority = 0)
      *
      * Adding the Events::PRE_HANDLE and Events::POST_HANDLE events.
      */
-    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true): Response
+    public function handle(Request $request, $type = HttpKernelInterface::MAIN_REQUEST, $catch = true): Response
     {
         // trigger loading the CacheEvent to avoid fatal error when HttpKernel::loadClassCache is used.
         class_exists(CacheEvent::class);
@@ -102,10 +94,8 @@ class_exists(CacheEvent::class);
      * {@inheritdoc}
      *
      * Trigger event to alter response before storing it in the cache.
-     *
-     * @return void
      */
-    protected function store(Request $request, Response $response)
+    protected function store(Request $request, Response $response): void
     {
         $response = $this->dispatch(Events::PRE_STORE, $request, $response);
 
@@ -135,7 +125,7 @@ protected function invalidate(Request $request, $catch = false): Response
      *
      * @return Response|null The response to return, which might be provided/altered by a listener
      */
-    protected function dispatch($name, Request $request, Response $response = null, $requestType = HttpKernelInterface::MASTER_REQUEST): ?Response
+    protected function dispatch(string $name, Request $request, Response $response = null, int $requestType = HttpKernelInterface::MAIN_REQUEST): ?Response
     {
         if ($this->getEventDispatcher()->hasListeners($name)) {
             $event = new CacheEvent($this, $request, $response, $requestType);

src/SymfonyCache/KernelDispatcher.php

@@ -32,22 +32,19 @@
  */
 class KernelDispatcher implements Dispatcher
 {
-    /**
-     * @var HttpCacheProvider
-     */
-    private $httpCacheProvider;
+    private HttpCacheProvider $httpCacheProvider;
 
     /**
-     * @var array
+     * @var Request[]
      */
-    private $queue = [];
+    private array $queue = [];
 
     public function __construct(HttpCacheProvider $httpCacheProvider)
     {
         $this->httpCacheProvider = $httpCacheProvider;
     }
 
-    public function invalidate(RequestInterface $invalidationRequest, $validateHost = true)
+    public function invalidate(RequestInterface $invalidationRequest, $validateHost = true): void
     {
         $request = Request::create(
             $invalidationRequest->getUri(),
@@ -82,7 +79,7 @@ public function invalidate(RequestInterface $invalidationRequest, $validateHost
         $this->queue[sha1($request)] = $request;
     }
 
-    public function flush()
+    public function flush(): int
     {
         if (!count($this->queue)) {
             return 0;
@@ -98,7 +95,7 @@ public function flush()
 
         foreach ($queue as $request) {
             try {
-                $httpCache->handle($request, HttpKernelInterface::MASTER_REQUEST, false);
+                $httpCache->handle($request, HttpKernelInterface::MAIN_REQUEST, false);
             } catch (\Exception $e) {
                 $exceptions->add($e);
             }

tests/Functional/Fixtures/Symfony/AppKernel.php

@@ -25,7 +25,7 @@ class AppKernel implements HttpKernelInterface
      *
      * {@inheritdoc}
      */
-    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true): Response
+    public function handle(Request $request, $type = HttpKernelInterface::MAIN_REQUEST, $catch = true): Response
     {
         switch ($request->getPathInfo()) {
             case '/cache':

tests/Functional/Symfony/EventDispatchingHttpCacheTest.php

@@ -43,7 +43,7 @@ public function testEventListeners()
 
         $httpKernel = \Mockery::mock(HttpKernelInterface::class)
             ->shouldReceive('handle')
-            ->withArgs([$request, HttpKernelInterface::MASTER_REQUEST, true])
+            ->withArgs([$request, HttpKernelInterface::MAIN_REQUEST, true])
             ->andReturn($expectedResponse)
             ->getMock();
         $store = \Mockery::mock(StoreInterface::class)

tests/Functional/Varnish/UserContextFailureTest.php

@@ -32,7 +32,7 @@ public function setUp(): void
     {
         // needs to be decided before doing the setup
         // phpunit 9 calls the method getName(), phpunit 10 name()
-        $name = method_exists($this, 'name') ? $this->name() : $this->getName(); /* @phpstan-ignore-line */
+        $name = method_exists($this, 'name') ? $this->name() : $this->getName();
         $this->mode = 'testHashRequestFailure' === $name ? 'failure' : 'cache';
 
         parent::setUp();

tests/Unit/SymfonyCache/CacheEventTest.php

@@ -40,7 +40,7 @@ public function testEventGetters()
         $this->assertSame($this->kernel, $event->getKernel());
         $this->assertSame($request, $event->getRequest());
         $this->assertNull($event->getResponse());
-        $this->assertSame(HttpKernelInterface::MASTER_REQUEST, $event->getRequestType());
+        $this->assertSame(HttpKernelInterface::MAIN_REQUEST, $event->getRequestType());
 
         $response = new Response();
 

tests/Unit/SymfonyCache/PurgeListenerTest.php

@@ -190,7 +190,7 @@ private function createRequestMatcher(string $path): RequestMatcherInterface
     {
         return class_exists(PathRequestMatcher::class)
             ? new PathRequestMatcher($path)
-            : new RequestMatcher($path)
+            : new RequestMatcher($path) /* @phpstan-ignore-line */
         ;
     }
 

tests/Unit/SymfonyCache/PurgeTagsListenerTest.php

@@ -19,6 +19,8 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestMatcher;
+use Symfony\Component\HttpFoundation\RequestMatcher\PathRequestMatcher;
+use Symfony\Component\HttpFoundation\RequestMatcherInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpCache\StoreInterface;
 use Toflar\Psr6HttpCacheStore\Psr6Store;
@@ -43,7 +45,9 @@ public function testConstructorOverspecified()
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionMessage('You may not set both a request matcher and an IP');
         new PurgeTagsListener([
-            'client_matcher' => new RequestMatcher('/forbidden'),
+            'client_matcher' => class_exists(PathRequestMatcher::class)
+                ? new PathRequestMatcher('/forbidden')
+                : new RequestMatcher('/forbidden'), /* @phpstan-ignore-line */
             'client_ips' => ['1.2.3.4'],
         ]);
     }
@@ -122,7 +126,9 @@ public function testPurgeForbiddenMatcher()
     {
         $kernel = $this->getUnusedKernelMock();
 
-        $matcher = new RequestMatcher('/forbidden');
+        $matcher = class_exists(PathRequestMatcher::class)
+            ? new PathRequestMatcher('/forbidden')
+            : new RequestMatcher('/forbidden'); /* @phpstan-ignore-line */
         $purgeTagsListener = new PurgeTagsListener(['client_matcher' => $matcher]);
         $request = Request::create('http://example.com/foo', 'PURGETAGS');
         $event = new CacheEvent($kernel, $request);
@@ -155,7 +161,7 @@ public function testPurgeForbiddenIp()
     public function testOtherMethod()
     {
         $kernel = $this->getUnusedKernelMock();
-        $matcher = \Mockery::mock(RequestMatcher::class)
+        $matcher = \Mockery::mock(RequestMatcherInterface::class)
             ->shouldNotReceive('isRequestAllowed')
             ->getMock();
 

tests/Unit/SymfonyCache/RefreshListenerTest.php

@@ -60,7 +60,7 @@ public function testRefreshForbiddenMatcher()
 
         $matcher = class_exists(PathRequestMatcher::class)
             ? new PathRequestMatcher('/forbidden')
-            : new RequestMatcher('/forbidden')
+            : new RequestMatcher('/forbidden') /* @phpstan-ignore-line */
         ;
         $refreshListener = new RefreshListener(['client_matcher' => $matcher]);
         $request = Request::create('http://example.com/foo');