Add support for Symfony 6.3

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.3.1
+### Added
+- Support for `Symfony 6.3`
+
+### Dropped
+- Support for `Symfony 2.8`
+
 ## 1.3.0
 ### Added
 - Support for PHP 8.

composer.json

@@ -15,14 +15,16 @@
         }
     },
     "require": {
-        "php": ">=7.0|>=8.0",
+        "php": "^7.0|^8.0",
         "doctrine/orm": "^2.0",
         "psr/log": "^1.0|^2.0",
-        "symfony/property-access": "^2.8|^3.0|^4.0|^5.0",
-        "ext-json": "*"
+        "ext-json": "*",
+        "symfony/property-access": "^3.4|^4.4|^5.4|^6.3",
+        "doctrine/annotations": "^1.0|^2.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.0|^9.0"
+        "phpunit/phpunit": "^6.0|^9.0",
+        "symfony/cache": "^3.4|^4.4|^5.4|^6.3"
     },
     "config": {
         "bin-dir": "bin"

phpunit.xml.dist

@@ -1,27 +1,28 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <!-- http://www.phpunit.de/manual/current/en/appendixes.configuration.html -->
+
 <phpunit
-    backupGlobals               = "false"
-    backupStaticAttributes      = "false"
-    colors                      = "true"
-    convertErrorsToExceptions   = "true"
-    convertNoticesToExceptions  = "true"
-    convertWarningsToExceptions = "true"
-    processIsolation            = "false"
-    stopOnFailure               = "false"
-    syntaxCheck                 = "false"
-    bootstrap                   = "vendor/autoload.php" >
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        colors="true" convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        processIsolation="false"
+        stopOnFailure="false"
+        bootstrap="vendor/autoload.php"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+
+    <coverage>
+        <include>
+        <directory>./src</directory>
+    </include>
 
-    <testsuites>
-        <testsuite name="Project Test Suite">
+    </coverage>
+        <testsuites>
+            <testsuite name="Project Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory>./src</directory>
-        </whitelist>
-    </filter>
 </phpunit>

src/Exception/TooLargeOffsetException.php

@@ -5,7 +5,13 @@
 
 class TooLargeOffsetException extends PaginationException
 {
+    /**
+     * @var int
+     */
     private $maximumOffset;
+    /**
+     * @var int
+     */
     private $givenOffset;
 
     public function __construct(int $maximumOffset, int $givenOffset)

src/Service/CursorBuilder.php

@@ -56,7 +56,7 @@ public function invertCursorInclusion(string $cursor): string
 
     /**
      * @param mixed $item
-     * @param array|\Paysera\Pagination\Entity\OrderingConfiguration[] $orderingConfigurations
+     * @param array|OrderingConfiguration[] $orderingConfigurations
      * @return string
      */
     public function getCursorFromItem($item, array $orderingConfigurations): string

src/Service/Doctrine/FlushingResultIterator.php

@@ -20,7 +20,7 @@ public function __construct(
         $this->entityManager = $entityManager;
     }
 
-    protected function handleCycleEnd()
+    protected function handleCycleEnd(): void
     {
         $this->entityManager->flush();
         $this->entityManager->clear();

src/Service/Doctrine/QueryAnalyser.php

@@ -8,7 +8,6 @@
 use Paysera\Pagination\Entity\Doctrine\AnalysedQuery;
 use Paysera\Pagination\Entity\OrderingConfiguration;
 use Paysera\Pagination\Entity\Doctrine\ConfiguredQuery;
-use Paysera\Pagination\Entity\OrderingPair;
 use Paysera\Pagination\Entity\Pager;
 use InvalidArgumentException;
 use Paysera\Pagination\Exception\TooLargeOffsetException;
@@ -23,7 +22,7 @@ class QueryAnalyser
      * @param Pager $pager
      * @return AnalysedQuery
      */
-    public function analyseQuery(ConfiguredQuery $configuredQuery, Pager $pager)
+    public function analyseQuery(ConfiguredQuery $configuredQuery, Pager $pager): AnalysedQuery
     {
         $analysedQuery = $this->analyseQueryWithoutPager($configuredQuery);
 
@@ -51,7 +50,7 @@ public function analyseQuery(ConfiguredQuery $configuredQuery, Pager $pager)
      * @param ConfiguredQuery $configuredQuery
      * @return AnalysedQuery
      */
-    public function analyseQueryWithoutPager(ConfiguredQuery $configuredQuery)
+    public function analyseQueryWithoutPager(ConfiguredQuery $configuredQuery): AnalysedQuery
     {
         $queryBuilder = $configuredQuery->getQueryBuilder();
         $rootAlias = $this->getRootAlias($queryBuilder);
@@ -65,11 +64,7 @@ public function analyseQueryWithoutPager(ConfiguredQuery $configuredQuery)
         ;
     }
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     * @return null|string
-     */
-    private function getRootAlias(QueryBuilder $queryBuilder)
+    private function getRootAlias(QueryBuilder $queryBuilder): ?string
     {
         $selectDqlParts = $queryBuilder->getDQLPart('select');
         if (!isset($selectDqlParts[0])) {
@@ -93,14 +88,11 @@ private function getRootAlias(QueryBuilder $queryBuilder)
         return $selectParts[0];
     }
 
-    /**
-     * @param ConfiguredQuery $configuredQuery
-     * @param string $rootAlias
-     * @param array|OrderingPair[] $orderingPairs
-     * @return array|OrderingConfiguration[]
-     */
-    private function mapToOrderingConfigurations(ConfiguredQuery $configuredQuery, string $rootAlias, array $orderingPairs)
-    {
+    private function mapToOrderingConfigurations(
+        ConfiguredQuery $configuredQuery,
+        string $rootAlias,
+        array $orderingPairs
+    ): array {
         $orderingConfigurations = [];
         $idIncluded = false;
         $defaultAscending = null;

src/Service/Doctrine/ResultIterator.php

@@ -55,7 +55,7 @@ public function iterate(ConfiguredQuery $configuredQuery, Pager $startPager = nu
         }
     }
 
-    protected function handleCycleEnd()
+    protected function handleCycleEnd(): void
     {
         // intentionally empty – override in extended classes
     }

src/Service/Doctrine/ResultProvider.php

@@ -3,14 +3,15 @@
 
 namespace Paysera\Pagination\Service\Doctrine;
 
+use Doctrine\ORM\NonUniqueResultException;
+use Doctrine\ORM\NoResultException;
 use Doctrine\ORM\Query\Expr;
 use Doctrine\ORM\Query\Expr\Andx;
 use Doctrine\ORM\Query\Expr\Orx;
 use Doctrine\ORM\Query\Expr\GroupBy;
 use Doctrine\ORM\Query\Expr\Comparison;
 use Doctrine\ORM\QueryBuilder;
 use Paysera\Pagination\Entity\Doctrine\AnalysedQuery;
-use Paysera\Pagination\Entity\OrderingConfiguration;
 use Paysera\Pagination\Entity\Doctrine\ConfiguredQuery;
 use Paysera\Pagination\Entity\Pager;
 use Paysera\Pagination\Entity\Result;
@@ -28,6 +29,13 @@ public function __construct(QueryAnalyser $queryAnalyser, CursorBuilderInterface
         $this->cursorBuilder = $cursorBuilder;
     }
 
+    /**
+     * @param ConfiguredQuery $configuredQuery
+     * @param Pager $pager
+     * @return Result
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
     public function getResultForQuery(ConfiguredQuery $configuredQuery, Pager $pager): Result
     {
         $analysedQuery = $this->queryAnalyser->analyseQuery($configuredQuery, $pager);
@@ -49,6 +57,12 @@ public function getResultForQuery(ConfiguredQuery $configuredQuery, Pager $pager
         return $result;
     }
 
+    /**
+     * @param ConfiguredQuery $configuredQuery
+     * @return int
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
     public function getTotalCountForQuery(ConfiguredQuery $configuredQuery): int
     {
         $analysedQuery = $this->queryAnalyser->analyseQueryWithoutPager($configuredQuery);
@@ -89,7 +103,7 @@ private function findItems(AnalysedQuery $analysedQuery, Pager $pager)
         return $items;
     }
 
-    private function pageQueryBuilder(AnalysedQuery $analysedQuery, Pager $pager)
+    private function pageQueryBuilder(AnalysedQuery $analysedQuery, Pager $pager): QueryBuilder
     {
         $queryBuilder = $analysedQuery->cloneQueryBuilder();
 
@@ -115,11 +129,7 @@ private function pageQueryBuilder(AnalysedQuery $analysedQuery, Pager $pager)
         return $queryBuilder;
     }
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     * @param array|OrderingConfiguration[] $orderingConfigurations
-     */
-    private function applyOrdering(QueryBuilder $queryBuilder, array $orderingConfigurations)
+    private function applyOrdering(QueryBuilder $queryBuilder, array $orderingConfigurations): void
     {
         foreach ($orderingConfigurations as $orderingConfiguration) {
             $queryBuilder->addOrderBy(
@@ -129,39 +139,27 @@ private function applyOrdering(QueryBuilder $queryBuilder, array $orderingConfig
         }
     }
 
-    private function applyOffset(QueryBuilder $queryBuilder, int $offset)
+    private function applyOffset(QueryBuilder $queryBuilder, int $offset): void
     {
         $queryBuilder->setFirstResult($offset);
     }
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     * @param string $after
-     * @param AnalysedQuery $analysedQuery
-     */
-    private function applyAfter(QueryBuilder $queryBuilder, string $after, AnalysedQuery $analysedQuery)
+    private function applyAfter(QueryBuilder $queryBuilder, string $after, AnalysedQuery $analysedQuery): void
     {
         $this->applyCursor($queryBuilder, $after, $analysedQuery, false);
     }
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     * @param string $after
-     * @param AnalysedQuery $analysedQuery
-     */
-    private function applyBefore(QueryBuilder $queryBuilder, string $after, AnalysedQuery $analysedQuery)
+    private function applyBefore(QueryBuilder $queryBuilder, string $after, AnalysedQuery $analysedQuery): void
     {
         $this->applyCursor($queryBuilder, $after, $analysedQuery, true);
     }
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     * @param string $cursor
-     * @param AnalysedQuery $analysedQuery
-     * @param bool $invert
-     */
-    private function applyCursor(QueryBuilder $queryBuilder, string $cursor, AnalysedQuery $analysedQuery, bool $invert)
-    {
+    private function applyCursor(
+        QueryBuilder $queryBuilder,
+        string $cursor,
+        AnalysedQuery $analysedQuery,
+        bool $invert
+    ): void {
         $orderingConfigurations = $analysedQuery->getOrderingConfigurations();
         $parsedCursor = $this->cursorBuilder->parseCursor($cursor, count($orderingConfigurations));
 
@@ -265,18 +263,18 @@ private function buildResultForTooLargeOffset(AnalysedQuery $analysedQuery): Res
             return $result->setHasPrevious(false);
         }
 
-        $lastItemCursor = $this->cursorBuilder->getCursorFromItem($items[0], $modifiedAnalysedQuery->getOrderingConfigurations());
+        $lastItemCursor = $this->cursorBuilder->getCursorFromItem(
+            $items[0],
+            $modifiedAnalysedQuery->getOrderingConfigurations()
+        );
+
         return $result
             ->setHasPrevious(true)
             ->setPreviousCursor($this->cursorBuilder->buildCursorWithIncludedItem($lastItemCursor))
             ->setNextCursor($lastItemCursor)
         ;
     }
 
-    /**
-     * @param array|OrderingConfiguration[] $orderingConfigurations
-     * @return array|OrderingConfiguration[]
-     */
     private function reverseOrderingDirection(array $orderingConfigurations): array
     {
         $reversedOrderingConfigurations = [];
@@ -288,7 +286,7 @@ private function reverseOrderingDirection(array $orderingConfigurations): array
         return $reversedOrderingConfigurations;
     }
 
-    private function existsBeforeCursor(string $previousCursor, AnalysedQuery $analysedQuery)
+    private function existsBeforeCursor(string $previousCursor, AnalysedQuery $analysedQuery): bool
     {
         $nextPager = (new Pager())
             ->setBefore($previousCursor)
@@ -298,7 +296,7 @@ private function existsBeforeCursor(string $previousCursor, AnalysedQuery $analy
         return count($this->findItems($analysedQuery, $nextPager)) > 0;
     }
 
-    private function existsAfterCursor(string $nextCursor, AnalysedQuery $analysedQuery)
+    private function existsAfterCursor(string $nextCursor, AnalysedQuery $analysedQuery): bool
     {
         $nextPager = (new Pager())
             ->setAfter($nextCursor)
@@ -308,7 +306,7 @@ private function existsAfterCursor(string $nextCursor, AnalysedQuery $analysedQu
         return count($this->findItems($analysedQuery, $nextPager)) > 0;
     }
 
-    private function calculateTotalCount(Pager $filter, int $resultCount)
+    private function calculateTotalCount(Pager $filter, int $resultCount): ?int
     {
         if (
             $filter->getOffset() !== null
@@ -321,6 +319,12 @@ private function calculateTotalCount(Pager $filter, int $resultCount)
         return null;
     }
 
+    /**
+     * @param AnalysedQuery $analysedQuery
+     * @return int
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
     private function findCount(AnalysedQuery $analysedQuery): int
     {
         $countQueryBuilder = $analysedQuery->cloneQueryBuilder();
@@ -334,6 +338,13 @@ private function findCount(AnalysedQuery $analysedQuery): int
         return (int)$countQueryBuilder->getQuery()->getSingleScalarResult();
     }
 
+    /**
+     * @param string $groupByColumn
+     * @param AnalysedQuery $analysedQuery
+     * @return int
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
     private function findCountWithGroupBy(string $groupByColumn, AnalysedQuery $analysedQuery): int
     {
         $countQueryBuilder = $analysedQuery->cloneQueryBuilder();
@@ -355,11 +366,7 @@ private function findCountWithGroupBy(string $groupByColumn, AnalysedQuery $anal
         return $nonNullCount + $nullExists;
     }
 
-    /**
-     * @param QueryBuilder $queryBuilder
-     * @return string|null
-     */
-    private function getSingleValidGroupByColumn(QueryBuilder $queryBuilder)
+    private function getSingleValidGroupByColumn(QueryBuilder $queryBuilder): ?string
     {
         /** @var GroupBy[] $groupByParts */
         $groupByParts = $queryBuilder->getDQLPart('groupBy');