Safely count all possible types

Author: KorvinSzanto

phpstan.neon.dist

@@ -6,3 +6,5 @@ parameters:
   reportUnmatchedIgnoredErrors: false
   paths:
     - src
+  bootstrapFiles:
+    - test/phpstan.php

psalm.xml

@@ -8,6 +8,7 @@
     errorBaseline="psalm.baseline.xml"
 >
     <projectFiles>
+        <file name="test/phpstan.php" />
         <directory name="src" />
         <ignoreFiles>
             <directory name="vendor" />

src/Pagination/DoctrinePaginatorAdapter.php

@@ -19,6 +19,8 @@
  */
 class DoctrinePaginatorAdapter implements PaginatorInterface
 {
+    use TraversableCountTrait;
+
     /**
      * The paginator instance.
      * @var  Paginator
@@ -73,7 +75,7 @@ public function getTotal(): int
      */
     public function getCount(): int
     {
-        return $this->paginator->getIterator()->count();
+        return $this->getTraversableCount($this->paginator->getIterator());
     }
 
     /**
@@ -93,7 +95,7 @@ public function getUrl(int $page): string
     }
 
     /**
-     * Get the the route generator.
+     * Get the route generator.
      */
     private function getRouteGenerator(): callable
     {

src/Pagination/TraversableCountTrait.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace League\Fractal\Pagination;
+
+trait TraversableCountTrait
+{
+    /**
+     * Safely get the count from a traversable
+     */
+    private function getTraversableCount(\Traversable $traversable): int
+    {
+        if ($traversable instanceof \Countable) {
+            return count($traversable);
+        }
+
+        // Call the "count" method if it exists
+        if (method_exists($traversable, 'count')) {
+            return $traversable->count();
+        }
+
+        // If not, fall back to iterator_count and rewind if possible
+        $count = iterator_count($traversable);
+        if ($traversable instanceof \Iterator || $traversable instanceof \IteratorAggregate) {
+            $traversable->rewind();
+        }
+
+        return $count;
+    }
+
+}

test/Pagination/DoctrinePaginatorAdapterTest.php

@@ -2,7 +2,9 @@
 namespace League\Fractal\Test\Pagination;
 
 use Doctrine\ORM\Query;
+use Doctrine\ORM\Tools\Pagination\Paginator;
 use League\Fractal\Pagination\DoctrinePaginatorAdapter;
+use League\Fractal\Test\Stub\SimpleTraversable;
 use Mockery;
 use PHPUnit\Framework\TestCase;
 
@@ -28,11 +30,9 @@ public function testPaginationAdapter()
         $paginator->shouldReceive('getQuery')->andReturn($query);
 
         //Mock the iterator of the paginator
-        $iterator = Mockery::mock('IteratorAggregate');
-        $iterator->shouldReceive('count')->andReturn($count);
+        $iterator = new \ArrayIterator(range(1, $count));
         $paginator->shouldReceive('getIterator')->andReturn($iterator);
 
-
         $adapter = new DoctrinePaginatorAdapter($paginator, function ($page) {
             return 'http://example.com/foo?page='.$page;
         });
@@ -57,6 +57,20 @@ public function testPaginationAdapter()
         );
     }
 
+    public function testCountingTraversables()
+    {
+        $traversable = new SimpleTraversable(range(1, 100));
+        $adapter = Mockery::mock('Doctrine\ORM\Tools\Pagination\Paginator');
+        $adapter->shouldReceive('getIterator')->andReturn($traversable);
+        $adapter = new DoctrinePaginatorAdapter($adapter, function ($page) {
+            return (string) $page;
+        });
+
+        $this->assertEquals($traversable->key(), 0);
+        $this->assertEquals($adapter->getCount(), 100);
+        $this->assertEquals($traversable->key(), 0);
+    }
+
     public function tearDown(): void
     {
         Mockery::close();

test/Stub/SimpleTraversable.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace League\Fractal\Test\Stub;
+
+class SimpleTraversable implements \Iterator
+{
+    private $list;
+    private $keys;
+    private $cursor = 0;
+
+    public function __construct(array $list)
+    {
+        $this->list = array_values($list);
+        $this->keys = array_keys($list);
+    }
+
+    #[\ReturnTypeWillChange]
+    public function current()
+    {
+        return $this->list[$this->cursor];
+    }
+
+    public function next(): void
+    {
+        $this->cursor++;
+    }
+
+    #[\ReturnTypeWillChange]
+    public function key()
+    {
+        return $this->keys[$this->cursor];
+    }
+
+    public function valid(): bool
+    {
+        return isset($this->list[$this->cursor]);
+    }
+
+    public function rewind(): void
+    {
+        $this->cursor = 0;
+    }
+}

test/phpstan.php

@@ -0,0 +1,4 @@
+<?php
+
+class_alias(\Laminas\Paginator\Adapter\ArrayAdapter::class, \Zend\Paginator\Adapter\ArrayAdapter::class);
+class_alias(\Laminas\Paginator\Paginator::class, \Zend\Paginator\Paginator::class);