Replace Porpaginas with self-owned code

- Interface signatures now compatible with PHP 8.1 (covariance issue)

Author: dsavina

composer.json

@@ -24,7 +24,6 @@
         "doctrine/dbal": "^2.9.2",
         "psr/log": "^1 || ^2 || ^3",
         "doctrine/inflector": "^1.4.3 || ^2",
-        "beberlei/porpaginas": "~1.0",
         "mouf/classname-mapper": "~1.0",
         "doctrine/cache": "^1.6",
         "greenlion/php-sql-parser": "^4.3.0",

src/AlterableResultIterator.php

@@ -4,17 +4,13 @@
 
 namespace TheCodingMachine\TDBM;
 
-use Porpaginas\Arrays\ArrayPage;
-use Porpaginas\Iterator;
-use Porpaginas\Result;
-
 /**
  * This class acts as a wrapper around a result iterator.
  * It can be used to add or remove results from a ResultIterator (or any kind a traversable collection).
  *
  * Note: in the case of TDBM, this is useful to manage many to one relationships
  */
-class AlterableResultIterator implements Result, \ArrayAccess, \JsonSerializable
+class AlterableResultIterator implements ResultInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * @var \Traversable|null
@@ -202,16 +198,10 @@ public function offsetUnset($offset)
         throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.');
     }
 
-    /**
-     * @param int $offset
-     * @param int $limit
-     *
-     * @return \Porpaginas\Page
-     */
-    public function take($offset, $limit)
+    public function take(int $offset, int $limit): PageInterface
     {
         // TODO: replace this with a class implementing the map method.
-        return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray()));
+        return new PageArray(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray()));
     }
 
     /**

src/PageArray.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\TDBM;
+
+use ArrayIterator;
+use Traversable;
+
+class PageArray implements PageInterface
+{
+    private array $items;
+    private int $offset;
+    private int $limit;
+    private int $totalCount;
+
+    /**
+     * @param array $items
+     */
+    public function __construct(array $items, int $offset, int $limit, int $totalCount)
+    {
+        $this->items = $items;
+        $this->offset = $offset;
+        $this->limit = $limit;
+        $this->totalCount = $totalCount;
+    }
+
+    public function count(): int
+    {
+        return count($this->items);
+    }
+
+    public function totalCount(): int
+    {
+        return $this->totalCount;
+    }
+
+    public function getCurrentOffset(): int
+    {
+        return $this->offset;
+    }
+
+    public function getCurrentPage(): int
+    {
+        return (int) floor($this->offset / $this->limit) + 1;
+    }
+
+    public function getCurrentLimit(): int
+    {
+        return $this->limit;
+    }
+
+    public function getIterator(): Traversable
+    {
+        return new ArrayIterator($this->items);
+    }
+}

src/PageInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\TDBM;
+
+use Countable;
+use IteratorAggregate;
+
+interface PageInterface extends Countable, IteratorAggregate
+{
+    /**
+     * Returns the total number of results in the paginated collection.
+     */
+    public function totalCount(): int;
+
+    public function getCurrentOffset(): int;
+
+    public function getCurrentPage(): int;
+
+    public function getCurrentLimit(): int;
+}

src/PageIterator.php

@@ -6,7 +6,6 @@
 
 use Doctrine\DBAL\Statement;
 use Mouf\Database\MagicQuery;
-use Porpaginas\Page;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 
@@ -31,7 +30,7 @@
 /**
  * Iterator used to retrieve results.
  */
-class PageIterator implements Page, \ArrayAccess, \JsonSerializable
+class PageIterator implements PageInterface, \ArrayAccess, \JsonSerializable
 {
     /** @var Statement */
     protected $statement;
@@ -133,46 +132,33 @@ public function getIterator()
         return $this->innerResultIterator;
     }
 
-    /**
-     * @return int
-     */
-    public function getCurrentOffset()
+    public function getCurrentOffset(): int
     {
         return $this->offset;
     }
 
-    /**
-     * @return int
-     */
-    public function getCurrentPage()
+    public function getCurrentPage(): int
     {
         return (int) floor($this->offset / $this->limit) + 1;
     }
 
-    /**
-     * @return int
-     */
-    public function getCurrentLimit()
+    public function getCurrentLimit(): int
     {
         return $this->limit;
     }
 
     /**
      * Return the number of results on the current page of the {@link Result}.
-     *
-     * @return int
      */
-    public function count()
+    public function count(): int
     {
         return $this->getIterator()->count();
     }
 
     /**
      * Return the number of ALL results in the paginatable of {@link Result}.
-     *
-     * @return int
      */
-    public function totalCount()
+    public function totalCount(): int
     {
         return $this->parentResult->count();
     }

src/ResultInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\TDBM;
+
+use Countable;
+use IteratorAggregate;
+
+interface ResultInterface extends Countable, IteratorAggregate
+{
+    public function take(int $offset, int $limit): PageInterface;
+}

src/ResultIterator.php

@@ -10,7 +10,6 @@
 use Doctrine\DBAL\Statement;
 use Mouf\Database\MagicQuery;
 use TheCodingMachine\TDBM\QueryFactory\QueryFactory;
-use Porpaginas\Result;
 use Psr\Log\LoggerInterface;
 use TheCodingMachine\TDBM\Utils\DbalUtils;
 use Traversable;
@@ -41,7 +40,7 @@
 /**
  * Iterator used to retrieve results.
  */
-class ResultIterator implements Result, \ArrayAccess, \JsonSerializable
+class ResultIterator implements ResultInterface, \ArrayAccess, \JsonSerializable
 {
     /** @var Statement */
     protected $statement;
@@ -176,13 +175,7 @@ public function getIterator()
         return $this->innerResultIterator;
     }
 
-    /**
-     * @param int $offset
-     * @param int $limit
-     *
-     * @return PageIterator
-     */
-    public function take($offset, $limit)
+    public function take(int $offset, int $limit): PageIterator
     {
         if ($this->totalCount === 0) {
             return PageIterator::createEmpyIterator($this);

tests/Dao/TestCountryDao.php

@@ -4,7 +4,7 @@
 
 namespace TheCodingMachine\TDBM\Dao;
 
-use Porpaginas\Result;
+use TheCodingMachine\TDBM\ResultInterface;
 use TheCodingMachine\TDBM\Test\Dao\Bean\CountryBean;
 use TheCodingMachine\TDBM\Test\Dao\Generated\CountryBaseDao;
 
@@ -14,7 +14,7 @@
 class TestCountryDao extends CountryBaseDao
 {
     /**
-     * @return CountryBean[]|Result
+     * @return CountryBean[]|ResultInterface
      */
     public function getCountriesByUserCount()
     {
@@ -30,7 +30,7 @@ public function getCountriesByUserCount()
     }
 
     /**
-     * @return CountryBean[]|Result
+     * @return CountryBean[]|ResultInterface
      */
     public function getCountriesUsingUnion()
     {
@@ -48,7 +48,7 @@ public function getCountriesUsingUnion()
     }
 
     /**
-     * @return CountryBean[]|Result
+     * @return CountryBean[]|ResultInterface
      */
     public function getCountriesUsingSimpleQuery()
     {
@@ -62,7 +62,7 @@ public function getCountriesUsingSimpleQuery()
     }
 
     /**
-     * @return CountryBean[]|Result
+     * @return CountryBean[]|ResultInterface
      */
     public function getCountriesUsingDistinctQuery()
     {

tests/TDBMServiceTest.php

@@ -248,7 +248,7 @@ public function testRawSqlFilterCountriesByUserCount(): void
 GROUP BY country.id
 HAVING COUNT(users.id) > 1;
 SQL;
-        /** @var Test\Dao\Bean\CountryBean[]|\Porpaginas\Result $beans */
+        /** @var Test\Dao\Bean\CountryBean[]|ResultInterface $beans */
         $beans = $this->tdbmService->findObjectsFromRawSql('country', $sql, [], null, Test\Dao\Bean\CountryBean::class, null, CountryResultIterator::class);
 
         $count = 0;
@@ -271,7 +271,7 @@ public function testRawSqlOrderCountriesByUserCount(): void
 ORDER BY COUNT(users.id);
 SQL;
 
-        /** @var Test\Dao\Bean\CountryBean[]|\Porpaginas\Result $beans */
+        /** @var Test\Dao\Bean\CountryBean[]|ResultInterface $beans */
         $beans = $this->tdbmService->findObjectsFromRawSql('country', $sql, [], null, Test\Dao\Bean\CountryBean::class, null, CountryResultIterator::class);
 
         $count = 0;
@@ -300,7 +300,7 @@ public function testRawSqlOrderUsersByCustomRoleOrder(): void
 ORDER BY MAX(IF(roles.name = 'Admins', 3, IF(roles.name = 'Writers', 2, IF(roles.name = 'Singers', 1, 0)))) DESC
 SQL;
 
-        /** @var Test\Dao\Bean\UserBean[]|\Porpaginas\Result $beans */
+        /** @var Test\Dao\Bean\UserBean[]|ResultInterface $beans */
         $beans = $this->tdbmService->findObjectsFromRawSql('contact', $sql, [], null, Test\Dao\Bean\UserBean::class, null, UserResultIterator::class);
 
         function getCustomOrder(Test\Dao\Bean\UserBean $contact)