Merge pull request #670 from FabianKoestring/doctrine-paginator-json-serializeable

Have `DoctrinePaginator` implement `JsonSerializable` to improve cache key creation

Author: driehle

src/DoctrineORMModule/Paginator/Adapter/DoctrinePaginator.php

@@ -5,12 +5,13 @@
 namespace DoctrineORMModule\Paginator\Adapter;
 
 use Doctrine\ORM\Tools\Pagination\Paginator;
+use JsonSerializable;
 use Laminas\Paginator\Adapter\AdapterInterface;
 
 /**
  * Paginator adapter for the Laminas\Paginator component
  */
-class DoctrinePaginator implements AdapterInterface
+class DoctrinePaginator implements AdapterInterface, JsonSerializable
 {
     /** @var Paginator */
     protected $paginator;
@@ -55,4 +56,15 @@ public function count()
     {
         return $this->paginator->count();
     }
+
+    /**
+     * @return array{select: string, count_select: int}
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'select' => $this->paginator->getQuery()->getSQL(),
+            'count_select' => $this->paginator->count(),
+        ];
+    }
 }

test/DoctrineORMModuleTest/Assets/Entity/FormEntity.php

@@ -20,7 +20,7 @@ class FormEntity
     protected $id;
 
     /**
-     * @ORM\Column(type="bool")
+     * @ORM\Column(type="boolean")
      *
      * @var bool
      */

test/DoctrineORMModuleTest/Assets/Entity/Issue237.php

@@ -6,7 +6,7 @@
 
 /**
  * @ORM\Entity
- * @ORM\Table(name="doctrine_orm_module_form_entity")
+ * @ORM\Table(name="doctrine_orm_module_form_entity_issue237")
  */
 class Issue237
 {

test/DoctrineORMModuleTest/Paginator/AdapterTestIgnore.php renamed to test/DoctrineORMModuleTest/Paginator/AdapterTest.php

@@ -12,9 +12,10 @@
 use DoctrineORMModuleTest\Assets\Fixture\TestFixture;
 use DoctrineORMModuleTest\Framework\TestCase;
 
+use function class_exists;
 use function count;
 
-class AdapterTestIgnore extends TestCase
+class AdapterTest extends TestCase
 {
     /** @var QueryBuilder */
     protected $queryBuilder;
@@ -29,6 +30,12 @@ public function setUp(): void
     {
         parent::setUp();
 
+        if (! class_exists(FixtureLoader::class)) {
+            $this->markTestIncomplete(
+                'DataFixtures must be installed to run this test.'
+            );
+        }
+
         $this->createDb();
         $loader = new FixtureLoader();
         $loader->addFixture(new TestFixture());
@@ -82,4 +89,14 @@ public function testGetsItemsAtOffsetTen(): void
             $this->assertEquals($expectedItem, $actual[$key]);
         }
     }
+
+    public function testJsonSerialize(): void
+    {
+        $result = $this->paginatorAdapter->jsonSerialize();
+
+        $this->assertArrayHasKey('select', $result);
+        $this->assertArrayHasKey('count_select', $result);
+        $this->assertSame($result['count_select'], $this->paginator->count());
+        $this->assertSame($result['select'], $this->paginator->getQuery()->getSQL());
+    }
 }