Merge pull request #206 from treschelet/feature/relay

add field total to ConnectionType

Author: dmongeau

src/Folklore/GraphQL/Relay/EdgesCollection.php

@@ -6,11 +6,22 @@
 
 class EdgesCollection extends Collection
 {
+    protected $total = 0;
     protected $startCursor = null;
     protected $endCursor = null;
     protected $hasNextPage = false;
     protected $hasPreviousPage = false;
 
+    public function setTotal($total)
+    {
+        $this->total = $total;
+    }
+
+    public function getTotal()
+    {
+        return $this->total;
+    }
+
     public function setHasNextPage($hasNextPage)
     {
         $this->hasNextPage = $hasNextPage;

src/Folklore/GraphQL/Relay/Support/ConnectionType.php

@@ -23,6 +23,12 @@ protected function edgeType()
     protected function fields()
     {
         return [
+            'total' => [
+                'type' => Type::int(),
+                'resolve' => function ($root) {
+                    return $this->getTotalFromRoot($root);
+                }
+            ],
             'edges' => [
                 'type' => Type::listOf($this->getEdgeObjectType()),
                 'resolve' => function ($root) {
@@ -70,6 +76,16 @@ protected function getCursorFromNode($edge)
         return $resolveId($edge);
     }
 
+    protected function getTotalFromRoot($root)
+    {
+        $total = 0;
+        if ($root instanceof EdgesCollection) {
+            $total = $root->getTotal();
+        }
+        return $total;
+    }
+
+
     protected function getEdgesFromRoot($root)
     {
         $cursor = $this->getStartCursorFromRoot($root);

src/Folklore/GraphQL/Relay/Support/Traits/ResolvesFromQueryBuilder.php

@@ -77,9 +77,10 @@ protected function resolveItemsFromQueryBuilder($query)
         return $query->get();
     }
 
-    protected function getCollectionFromItems($items, $offset, $limit, $hasPreviousPage, $hasNextPage)
+    protected function getCollectionFromItems($items, $offset, $limit, $total, $hasPreviousPage, $hasNextPage)
     {
         $collection = new EdgesCollection($items);
+        $collection->setTotal($total);
         $collection->setStartCursor($offset);
         $collection->setEndCursor($offset + $limit - 1);
         $collection->setHasNextPage($hasNextPage);
@@ -143,7 +144,7 @@ public function resolve($root, $args)
 
         $resolveItemsArguments = array_merge([$query], $arguments);
         $items = call_user_func_array([$this, 'resolveItemsFromQueryBuilder'], $resolveItemsArguments);
-        $collection = $this->getCollectionFromItems($items, $offset, $limit, $hasPreviousPage, $hasNextPage);
+        $collection = $this->getCollectionFromItems($items, $offset, $limit, $count, $hasPreviousPage, $hasNextPage);
 
         return $collection;
     }

tests/Relay/RelayEdgesCollectionTest.php

@@ -17,6 +17,20 @@ protected function getEnvironmentSetUp($app)
         $this->collection = new EdgesCollection();
     }
 
+    /**
+     * Test set and get total
+     *
+     * @test
+     * @covers ::setTotal
+     * @covers ::getTotal
+     */
+    public function testGetTotal()
+    {
+        $this->assertEquals(0, $this->collection->getTotal());
+        $this->collection->setTotal(1);
+        $this->assertEquals(1, $this->collection->getTotal());
+    }
+
     /**
      * Test set and get hasNextPage
      *

tests/Relay/RelayTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use GraphQL\Type\Definition\Type;
+use Folklore\GraphQL\Support\Type as BaseType;
 use Folklore\GraphQL\Relay\Support\ConnectionField;
 
 /**
@@ -54,4 +56,28 @@ public function testConnectionField()
         $this->assertInstanceOf(ConnectionField::class, $field);
         $this->assertEquals($name, $field->name);
     }
+
+    /**
+     * Test connection field from edge type
+     *
+     * @test
+     * @covers ::connectionFieldFromEdgeType
+     */
+    public function testConnectionFieldFromEdgeType()
+    {
+        $name = 'testConnectionField';
+        $edgeObjectType = new BaseType([
+            'name' => 'Test',
+            'fields' => [
+                'id' => [
+                    'type' => Type::int()
+                ]
+            ]
+        ]);
+        $field = $this->relay->connectionFieldFromEdgeType($edgeObjectType, [
+            'name' => $name
+        ]);
+        $this->assertInstanceOf(ConnectionField::class, $field);
+        $this->assertEquals($name, $field->name);
+    }
 }