Add a method to convert an entity collection into a paging collection

Author: deviantintegral

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 4
+
+[{*.ctp,*.engine,*.hphp,*.inc,*.install,*.module,*.php,*.php4,*.php5,*.phtml,*.profile,*.test,*.theme}]
+max_line_length = 80

src/Entity/Collection/EntityCollection.php

@@ -2,6 +2,7 @@
 
 namespace Hussainweb\DrupalApi\Entity\Collection;
 
+use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\ResponseInterface;
 use Symfony\Component\Serializer\Encoder\JsonDecode;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
@@ -36,6 +37,21 @@ public static function fromResponse(ResponseInterface $response)
         return new static((new JsonDecode())->decode((string) $response->getBody(), JsonEncoder::FORMAT));
     }
 
+    /**
+     * Construct a paging entity collection from this collection.
+     *
+     * @param \Psr\Http\Client\ClientInterface $client
+     *   The HTTP client used to fetch subsequent pages.
+     *
+     * @see \Hussainweb\DrupalApi\Client::getEntity
+     *
+     * @return \Hussainweb\DrupalApi\Entity\Collection\PagingEntityCollection
+     */
+    public function toPagingEntityCollection(ClientInterface $client): PagingEntityCollection
+    {
+        return new PagingEntityCollection($this->rawData, $client, $this->getListItemClass());
+    }
+
     /**
      * Get the name of the class for a list item.
      *

tests/Entity/Collection/PagingEntityCollectionTest.php

@@ -3,8 +3,12 @@
 namespace Hussainweb\DrupalApi\Tests\Entity\Collection;
 
 use GuzzleHttp\Psr7\Response;
+use Hussainweb\DrupalApi\Client;
+use Hussainweb\DrupalApi\Entity\Collection\CommentCollection;
 use Hussainweb\DrupalApi\Entity\Collection\PagingEntityCollection;
 use Hussainweb\DrupalApi\Entity\Comment;
+use Hussainweb\DrupalApi\Request\Collection\CommentCollectionRequest;
+use Hussainweb\DrupalApi\Request\Request;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Client\ClientInterface;
 
@@ -40,4 +44,37 @@ public function testPaging()
 
         $this->assertEquals(10, $count);
     }
+
+    public function testFromClient()
+    {
+        $data = json_decode(file_get_contents(__DIR__ . '/../../fixtures/comment-collection-page-0.json'));
+        /** @var \Hussainweb\DrupalApi\Client|\PHPUnit\Framework\MockObject\MockObject $client */
+        $client = $this->createMock(Client::class);
+        $page1 = json_decode(file_get_contents(
+            __DIR__ . '/../../fixtures/comment-collection-page-1.json'
+        ));
+
+        // Modify the fixture so there's only two pages.
+        unset($page1->next);
+        $page1 = json_encode($page1);
+
+        $comment_collection = new CommentCollection($data);
+        $client->expects($this->once())->method('getEntity')
+            ->willReturn($comment_collection);
+
+        $request = new CommentCollectionRequest();
+        $entity_collection = $client->getEntity($request);
+
+        $http_client = $this->createMock(ClientInterface::class);
+        $http_client->expects($this->once())->method('sendRequest')
+            ->willReturn(new Response(200, ['Content-Type' => 'application/json'], $page1));
+        $paging_collection = $entity_collection->toPagingEntityCollection($http_client);
+        $count = 0;
+        foreach ($paging_collection as $comment) {
+            $count++;
+            $this->assertInstanceOf(Comment::class, $comment);
+        }
+
+        $this->assertEquals(10, $count);
+    }
 }