Drop PHP 8.0 (#339)

W0rma · web-flow · commit 628425af05a6 · 2024-08-02T09:01:07.000+02:00
* Drop support for PHP 8.0
* Leverage PHP 8.1 features
* Fix version check since the expected exception is related to the installed symfony version
* Fix set-up of annotation reader
* Declare nullable parameter types explicitly

Implicit nullable parameter types will become deprecated in PHP 8.4
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -39,7 +39,7 @@ jobs:
             matrix:
                 include:
                     - description: 'Lowest'
-                      php: '8.0'
+                      php: '8.1'
                       composer_option: '--prefer-lowest'
                     - description: '8.1'
                       php: '8.1'
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -18,6 +18,7 @@
         'php_unit_mock_short_will_return' => true,
         'no_extra_blank_lines' => true,
         'no_unused_imports' => true,
+        'nullable_type_declaration_for_default_null_value' => true,
     ])
     ->setFinder($finder)
 ;
diff --git a/composer.json b/composer.json
@@ -22,7 +22,7 @@
         }
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "symfony/event-dispatcher-contracts": "^3.0"
     },
     "require-dev": {
diff --git a/src/Knp/Component/Pager/ArgumentAccess/RequestArgumentAccess.php b/src/Knp/Component/Pager/ArgumentAccess/RequestArgumentAccess.php
@@ -7,11 +7,8 @@
 
 final class RequestArgumentAccess implements ArgumentAccessInterface
 {
-    private RequestStack $requestStack;
-
-    public function __construct(RequestStack $requestStack)
+    public function __construct(private readonly RequestStack $requestStack)
     {
-        $this->requestStack = $requestStack;
     }
 
     public function has(string $name): bool
diff --git a/src/Knp/Component/Pager/Event/AfterEvent.php b/src/Knp/Component/Pager/Event/AfterEvent.php
@@ -10,15 +10,11 @@
  */
 final class AfterEvent extends Event
 {
-    /** @var PaginationInterface<int, mixed> */
-    private PaginationInterface $pagination;
-
     /**
-     * @param PaginationInterface<int, mixed> $paginationView
+     * @param PaginationInterface<int, mixed> $pagination
      */
-    public function __construct(PaginationInterface $paginationView)
+    public function __construct(private readonly PaginationInterface $pagination)
     {
-        $this->pagination = $paginationView;
     }
 
     /**
diff --git a/src/Knp/Component/Pager/Event/BeforeEvent.php b/src/Knp/Component/Pager/Event/BeforeEvent.php
@@ -13,9 +13,9 @@
 final class BeforeEvent extends Event
 {
     public function __construct(
-        private EventDispatcherInterface $eventDispatcher,
-        private ArgumentAccessInterface $argumentAccess,
-        private ?Connection $connection = null
+        private readonly EventDispatcherInterface $eventDispatcher,
+        private readonly ArgumentAccessInterface $argumentAccess,
+        private readonly ?Connection $connection = null
     ) {
     }
 
diff --git a/src/Knp/Component/Pager/Event/ItemsEvent.php b/src/Knp/Component/Pager/Event/ItemsEvent.php
@@ -29,18 +29,13 @@ final class ItemsEvent extends Event
      */
     public int $count;
 
-    private int $offset;
-    private int $limit;
-
     /**
      * @var array<string, mixed>
      */
     private array $customPaginationParams = [];
 
-    public function __construct(int $offset, int $limit)
+    public function __construct(private readonly int $offset, private readonly int $limit)
     {
-        $this->offset = $offset;
-        $this->limit = $limit;
     }
 
     public function setCustomPaginationParameter(string $name, mixed $value): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Filtration/Doctrine/ORM/QuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Filtration/Doctrine/ORM/QuerySubscriber.php
@@ -13,11 +13,8 @@
 
 class QuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Filtration/PropelQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Filtration/PropelQuerySubscriber.php
@@ -10,11 +10,8 @@
 
 class PropelQuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Paginate/Doctrine/DBALQueryBuilderSubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Paginate/Doctrine/DBALQueryBuilderSubscriber.php
@@ -14,7 +14,7 @@
  */
 class DBALQueryBuilderSubscriber implements EventSubscriberInterface
 {
-    public function __construct(private Connection $connection)
+    public function __construct(private readonly Connection $connection)
     {
     }
 
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/ArraySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/ArraySubscriber.php
@@ -23,18 +23,15 @@ class ArraySubscriber implements EventSubscriberInterface
      */
     private string $sortDirection;
 
-    private ?PropertyAccessorInterface $propertyAccessor;
+    private readonly ?PropertyAccessorInterface $propertyAccessor;
 
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess, PropertyAccessorInterface $accessor = null)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess, ?PropertyAccessorInterface $accessor = null)
     {
         if (!$accessor && class_exists(PropertyAccess::class)) {
             $accessor = PropertyAccess::createPropertyAccessorBuilder()->enableMagicCall()->getPropertyAccessor();
         }
 
         $this->propertyAccessor = $accessor;
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ODM/MongoDB/QuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ODM/MongoDB/QuerySubscriber.php
@@ -11,11 +11,8 @@
 
 class QuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ORM/QuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/Doctrine/ORM/QuerySubscriber.php
@@ -13,11 +13,8 @@
 
 class QuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/ElasticaQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/ElasticaQuerySubscriber.php
@@ -12,11 +12,8 @@
 
 class ElasticaQuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/PropelQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/PropelQuerySubscriber.php
@@ -10,11 +10,8 @@
 
 class PropelQuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Event/Subscriber/Sortable/SolariumQuerySubscriber.php b/src/Knp/Component/Pager/Event/Subscriber/Sortable/SolariumQuerySubscriber.php
@@ -15,11 +15,8 @@
  */
 class SolariumQuerySubscriber implements EventSubscriberInterface
 {
-    private ArgumentAccessInterface $argumentAccess;
-
-    public function __construct(ArgumentAccessInterface $argumentAccess)
+    public function __construct(private readonly ArgumentAccessInterface $argumentAccess)
     {
-        $this->argumentAccess = $argumentAccess;
     }
 
     public function items(ItemsEvent $event): void
diff --git a/src/Knp/Component/Pager/Exception/PageNumberOutOfRangeException.php b/src/Knp/Component/Pager/Exception/PageNumberOutOfRangeException.php
@@ -7,13 +7,9 @@
 
 class PageNumberOutOfRangeException extends OutOfRangeException
 {
-    private int $maxPageNumber;
-
-    public function __construct(?string $message, int $maxPageNumber, ?Throwable $previousException = null)
+    public function __construct(?string $message, private readonly int $maxPageNumber, ?Throwable $previousException = null)
     {
         parent::__construct($message, 0, $previousException);
-
-        $this->maxPageNumber = $maxPageNumber;
     }
 
     public function getMaxPageNumber(): int
diff --git a/src/Knp/Component/Pager/Pagination/SlidingPagination.php b/src/Knp/Component/Pager/Pagination/SlidingPagination.php
@@ -42,7 +42,7 @@ public function __toString(): string
             $output = call_user_func($this->renderer, $data);
         }
 
-        return $output;
+        return (string) $output;
     }
 
     /**
diff --git a/src/Knp/Component/Pager/Paginator.php b/src/Knp/Component/Pager/Paginator.php
@@ -35,9 +35,9 @@ final class Paginator implements PaginatorInterface
     ];
 
     public function __construct(
-        private EventDispatcherInterface $eventDispatcher,
+        private readonly EventDispatcherInterface $eventDispatcher,
         private ArgumentAccessInterface $argumentAccess,
-        private ?Connection $connection = null
+        private readonly ?Connection $connection = null
     ) {
     }
 
@@ -56,13 +56,13 @@ public function setDefaultPaginatorOptions(array $options): void
      *
      * @return PaginationInterface<int, mixed>
      */
-    public function paginate($target, int $page = 1, int $limit = null, array $options = []): PaginationInterface
+    public function paginate($target, int $page = 1, ?int $limit = null, array $options = []): PaginationInterface
     {
         if ($page <= 0) {
             throw PageNumberInvalidException::create($page);
         }
 
-        $limit = $limit ?? (int) $this->defaultOptions[self::DEFAULT_LIMIT];
+        $limit ??= (int) $this->defaultOptions[self::DEFAULT_LIMIT];
         if ($limit <= 0) {
             throw PageLimitInvalidException::create($limit);
         }
diff --git a/src/Knp/Component/Pager/PaginatorInterface.php b/src/Knp/Component/Pager/PaginatorInterface.php
@@ -45,5 +45,5 @@ interface PaginatorInterface
      *
      * @return PaginationInterface<int, mixed>
      */
-    public function paginate(mixed $target, int $page = 1, int $limit = null, array $options = []): PaginationInterface;
+    public function paginate(mixed $target, int $page = 1, ?int $limit = null, array $options = []): PaginationInterface;
 }
diff --git a/tests/Test/Fixture/TestItem.php b/tests/Test/Fixture/TestItem.php
@@ -4,11 +4,8 @@
 
 class TestItem
 {
-    private int $sortProperty;
-
-    public function __construct(int $sortProperty)
+    public function __construct(private readonly int $sortProperty)
     {
-        $this->sortProperty = $sortProperty;
     }
 
     public function getSortProperty(): int
diff --git a/tests/Test/Pager/Pagination/SlidingTest.php b/tests/Test/Pager/Pagination/SlidingTest.php
@@ -16,9 +16,7 @@ public function shouldBeAbleToProducePagination(): void
         $items = \range(1, 23);
         $view = $p->paginate($items, 1, 10);
 
-        $view->renderer = static function ($data) {
-            return 'custom';
-        };
+        $view->renderer = static fn($data) => 'custom';
         $this->assertEquals('custom', (string) $view);
 
         $pagination = $view->getPaginationData();
diff --git a/tests/Test/Pager/Pagination/TraversableItemsTest.php b/tests/Test/Pager/Pagination/TraversableItemsTest.php
@@ -16,9 +16,7 @@ public function shouldBeAbleToUseTraversableItems(): void
         $items = new \ArrayObject(\range(1, 23));
         $view = $p->paginate($items, 3, 10);
 
-        $view->renderer = static function ($data) {
-            return 'custom';
-        };
+        $view->renderer = static fn($data) => 'custom';
         $this->assertEquals('custom', (string)$view);
 
         $items = $view->getItems();
diff --git a/tests/Test/Pager/Subscriber/Filtration/Doctrine/ORM/QueryTest.php b/tests/Test/Pager/Subscriber/Filtration/Doctrine/ORM/QueryTest.php
@@ -42,9 +42,7 @@ public function shouldHandleApcQueryCache(): void
 
         $connection = DriverManager::getConnection($conn, $config);
         $em = new \Doctrine\ORM\EntityManager($connection, $config);
-        $schema = \array_map(static function (string $class) use ($em) {
-            return $em->getClassMetadata($class);
-        }, $this->getUsedEntityFixtures());
+        $schema = \array_map(static fn(string $class) => $em->getClassMetadata($class), $this->getUsedEntityFixtures());
 
         $schemaTool = new \Doctrine\ORM\Tools\SchemaTool($em);
         $schemaTool->dropSchema([]);
diff --git a/tests/Test/Pager/Subscriber/Paginate/Callback/CallbackTest.php b/tests/Test/Pager/Subscriber/Paginate/Callback/CallbackTest.php
@@ -65,12 +65,8 @@ private function givenCallbackPagination(): CallbackPagination
     {
         $data = \range(1, self::TOTAL_NUMBER_OF_ITEMS);
 
-        $count = function () use ($data) {
-            return \count($data);
-        };
-        $items = function ($offset, $limit) use ($data) {
-            return \array_slice($data, $offset, $limit);
-        };
+        $count = fn() => \count($data);
+        $items = fn($offset, $limit) => \array_slice($data, $offset, $limit);
 
         return new CallbackPagination($count, $items);
     }
diff --git a/tests/Test/Pager/Subscriber/Sortable/Doctrine/ORM/QueryTest.php b/tests/Test/Pager/Subscriber/Sortable/Doctrine/ORM/QueryTest.php
@@ -2,6 +2,7 @@
 
 namespace Test\Pager\Subscriber\Sortable\Doctrine\ORM;
 
+use Composer\InstalledVersions;
 use Doctrine\DBAL\DriverManager;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Tools\SchemaTool;
@@ -41,9 +42,7 @@ public function shouldHandleApcQueryCache(): void
 
         $connection = DriverManager::getConnection($conn, $config);
         $em = new EntityManager($connection, $config);
-        $schema = \array_map(static function ($class) use ($em) {
-            return $em->getClassMetadata($class);
-        }, $this->getUsedEntityFixtures());
+        $schema = \array_map(static fn($class) => $em->getClassMetadata($class), $this->getUsedEntityFixtures());
 
         $schemaTool = new SchemaTool($em);
         $schemaTool->dropSchema([]);
@@ -218,7 +217,12 @@ public function shouldNotExecuteExtraQueriesWhenCountIsZero(): void
      */
     public function shouldNotAcceptArrayParameter(): void
     {
-        $this->expectException(\PHP_VERSION_ID < 80100 ? \TypeError::class : \UnexpectedValueException::class);
+        if (version_compare(InstalledVersions::getVersion('symfony/http-foundation'), '6.0', '<')) {
+            $this->expectException(\TypeError::class);
+        } else {
+            $this->expectException(\UnexpectedValueException::class);
+        }
+
         $query = $this
             ->getMockSqliteEntityManager()
             ->createQuery('SELECT a FROM Test\Fixture\Entity\Article a')
diff --git a/tests/Test/Tool/BaseTestCaseMongoODM.php b/tests/Test/Tool/BaseTestCaseMongoODM.php
@@ -41,15 +41,15 @@ protected function tearDown(): void
      * DocumentManager mock object together with
      * annotation mapping driver and database
      */
-    protected function getMockDocumentManager(EventManager $evm = null): DocumentManager
+    protected function getMockDocumentManager(?EventManager $evm = null): DocumentManager
     {
         $conn = new Connection();
         $config = $this->getMockAnnotatedConfig();
 
         try {
             $this->dm = DocumentManager::create($conn, $config, $evm ?: $this->getEventManager());
             $this->dm->getConnection()->connect();
-        } catch (\MongoException $e) {
+        } catch (\MongoException) {
             $this->markTestSkipped('Doctrine MongoDB ODM failed to connect');
         }
         return $this->dm;
@@ -59,7 +59,7 @@ protected function getMockDocumentManager(EventManager $evm = null): DocumentMan
      * DocumentManager mock object with
      * annotation mapping driver
      */
-    protected function getMockMappedDocumentManager(EventManager $evm = null): DocumentManager
+    protected function getMockMappedDocumentManager(?EventManager $evm = null): DocumentManager
     {
         $conn = $this->createMock(Connection::class);
         $config = $this->getMockAnnotatedConfig();
diff --git a/tests/Test/Tool/BaseTestCaseORM.php b/tests/Test/Tool/BaseTestCaseORM.php
diff --git a/tests/Test/Tool/BaseTestCasePHPCRODM.php b/tests/Test/Tool/BaseTestCasePHPCRODM.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`'php_unit_mock_short_will_return' => true,`
`19`	`19`	`'no_extra_blank_lines' => true,`
`20`	`20`	`'no_unused_imports' => true,`
	`21`	`+ 'nullable_type_declaration_for_default_null_value' => true,`
`21`	`22`	`])`
`22`	`23`	`->setFinder($finder)`
`23`	`24`	`;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`}`
`23`	`23`	`],`
`24`	`24`	`"require": {`
`25`		`- "php": "^8.0",`
	`25`	`+ "php": "^8.1",`
`26`	`26`	`"symfony/event-dispatcher-contracts": "^3.0"`
`27`	`27`	`},`
`28`	`28`	`"require-dev": {`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,8 @@`
`7`	`7`
`8`	`8`	`final class RequestArgumentAccess implements ArgumentAccessInterface`
`9`	`9`	`{`
`10`		`- private RequestStack $requestStack;`
`11`		`-`
`12`		`- public function __construct(RequestStack $requestStack)`
	`10`	`+ public function __construct(private readonly RequestStack $requestStack)`
`13`	`11`	`{`
`14`		`- $this->requestStack = $requestStack;`
`15`	`12`	`}`
`16`	`13`
`17`	`14`	`public function has(string $name): bool`
Original file line number	Diff line number	Diff line change
`@@ -10,15 +10,11 @@`
`10`	`10`	`*/`
`11`	`11`	`final class AfterEvent extends Event`
`12`	`12`	`{`
`13`		`- /** @var PaginationInterface<int, mixed> */`
`14`		`- private PaginationInterface $pagination;`
`15`		`-`
`16`	`13`	`/**`
`17`		`- * @param PaginationInterface<int, mixed> $paginationView`
	`14`	`+ * @param PaginationInterface<int, mixed> $pagination`
`18`	`15`	`*/`
`19`		`- public function __construct(PaginationInterface $paginationView)`
	`16`	`+ public function __construct(private readonly PaginationInterface $pagination)`
`20`	`17`	`{`
`21`		`- $this->pagination = $paginationView;`
`22`	`18`	`}`
`23`	`19`
`24`	`20`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,9 @@`
`13`	`13`	`final class BeforeEvent extends Event`
`14`	`14`	`{`
`15`	`15`	`public function __construct(`
`16`		`- private EventDispatcherInterface $eventDispatcher,`
`17`		`- private ArgumentAccessInterface $argumentAccess,`
`18`		`- private ?Connection $connection = null`
	`16`	`+ private readonly EventDispatcherInterface $eventDispatcher,`
	`17`	`+ private readonly ArgumentAccessInterface $argumentAccess,`
	`18`	`+ private readonly ?Connection $connection = null`
`19`	`19`	`) {`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,8 @@`
`13`	`13`
`14`	`14`	`class QuerySubscriber implements EventSubscriberInterface`
`15`	`15`	`{`
`16`		`- private ArgumentAccessInterface $argumentAccess;`
`17`		`-`
`18`		`- public function __construct(ArgumentAccessInterface $argumentAccess)`
	`16`	`+ public function __construct(private readonly ArgumentAccessInterface $argumentAccess)`
`19`	`17`	`{`
`20`		`- $this->argumentAccess = $argumentAccess;`
`21`	`18`	`}`
`22`	`19`
`23`	`20`	`public function items(ItemsEvent $event): void`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,8 @@`
`10`	`10`
`11`	`11`	`class PropelQuerySubscriber implements EventSubscriberInterface`
`12`	`12`	`{`
`13`		`- private ArgumentAccessInterface $argumentAccess;`
`14`		`-`
`15`		`- public function __construct(ArgumentAccessInterface $argumentAccess)`
	`13`	`+ public function __construct(private readonly ArgumentAccessInterface $argumentAccess)`
`16`	`14`	`{`
`17`		`- $this->argumentAccess = $argumentAccess;`
`18`	`15`	`}`
`19`	`16`
`20`	`17`	`public function items(ItemsEvent $event): void`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`*/`
`15`	`15`	`class DBALQueryBuilderSubscriber implements EventSubscriberInterface`
`16`	`16`	`{`
`17`		`- public function __construct(private Connection $connection)`
	`17`	`+ public function __construct(private readonly Connection $connection)`
`18`	`18`	`{`
`19`	`19`	`}`
`20`	`20`