Show total count

src/Controller.php

@@ -249,6 +249,12 @@ protected function getDefaultReadResponse(
 
             $model->setLimit($this->getRequest()->getParam('limit'));
 
+            $includeTotalCount = $this->getRequest()->getParam('includeTotalCount') === 'true' ? true : false ;
+
+            if ($includeTotalCount === true) {
+                $model->setIncludeTotalCount($includeTotalCount);
+            }
+
             if ($filter) {
                 $model->addFilter($filter);
             }
@@ -260,8 +266,7 @@ protected function getDefaultReadResponse(
             }
 
             $model->read();
-
-            $response->initializeResponse($model->getData());
+            $response->initializeResponse($model);
         } else {
             if ($filter) {
                 if ($filter->getId()) {

src/Model/ModelTrait/DBReadTrait.php

@@ -2,6 +2,7 @@
 namespace NYPL\Starter\Model\ModelTrait;
 
 use NYPL\Starter\APIException;
+use NYPL\Starter\APILogger;
 use NYPL\Starter\DB;
 use NYPL\Starter\Filter;
 use NYPL\Starter\Filter\OrFilter;
@@ -289,6 +290,10 @@ protected function setSet($ignoreNoRecord = false)
         }
 
         if ($selectStatement->rowCount()) {
+            if ($this->isIncludeTotalCount() === true) {
+                $this->obtainTotalCount();
+            }
+
             $className = get_class($this->getBaseModel());
 
             foreach ($selectStatement->fetchAll() as $result) {
@@ -336,6 +341,30 @@ protected function addOrderBy(SelectStatement $selectStatement)
         return true;
     }
 
+    /**
+     * @return bool
+     */
+    protected function obtainTotalCount()
+    {
+        /**
+         * @var DBTrait $baseModel
+         */
+        $baseModel = $this->getBaseModel();
+
+        $selectStatement = DB::getDatabase()->select(['id'])
+            ->from($baseModel->translateDbName($baseModel->getTableName()))
+            ->groupBy('id');
+        if ($this->getFilters()) {
+            $this->applyFilters($this->getFilters(), $selectStatement);
+        }
+
+        $selectStatement = $selectStatement->count('id')->execute();
+
+        $this->setTotalCount($selectStatement->rowCount());
+
+        return true;
+    }
+
     /**
      * @param bool $ignoreNoRecord
      *

src/Model/Response/SuccessResponse.php

@@ -3,6 +3,7 @@
 
 use NYPL\Starter\Model;
 use NYPL\Starter\Model\Response;
+use NYPL\Starter\ModelSet;
 
 abstract class SuccessResponse extends Response
 {
@@ -16,13 +17,18 @@ abstract class SuccessResponse extends Response
      */
     public $count = 0;
 
+    /**
+     * @var int
+     */
+    public $totalCount;
+
     /**
      * @var int
      */
     public $statusCode;
 
     /**
-     * @param Model|Model[] $model
+     * @param Model|Model[]|ModelSet $model
      * @param int $code
      */
     public function __construct($model = null, $code = 200)
@@ -35,16 +41,46 @@ public function __construct($model = null, $code = 200)
     }
 
     /**
-     * @param Model|Model[] $model
+     * @param Model|Model[]|ModelSet $model
      */
     public function initializeResponse($model)
+    {
+        if (is_array($model)) {
+            $this->initializeArrayOfModels($model);
+        } else if ($model instanceof ModelSet) {
+            $this->initializeModelSet($model);
+        } else if ($model instanceof Model) {
+            $this->initializeModel($model);
+        }
+    }
+
+    /**
+     * @param Model $model
+     */
+    public function initializeModel($model)
     {
         $this->setData($model);
+        $this->setCount(1);
+    }
 
-        if (is_array($model)) {
-            $this->setCount(count($model));
-        } else {
-            $this->setCount(1);
+    /**
+     * @param Model[] $arrayOfModels
+     */
+    public function initializeArrayOfModels($arrayOfModels)
+    {
+        $this->setData($arrayOfModels);
+        $this->setCount(count($arrayOfModels));
+    }
+
+    /**
+     * @param ModelSet $modelSet
+     */
+    public function initializeModelSet($modelSet)
+    {
+        $this->setData($modelSet->getData());
+        $this->setCount(count($modelSet->getData()));
+        if ($modelSet->isIncludeTotalCount()) {
+            $this->setTotalCount($modelSet->getTotalCount());
         }
     }
 
@@ -95,4 +131,20 @@ public function setCount($count)
     {
         $this->count = $count;
     }
+
+    /**
+     * @return int
+     */
+    public function getTotalCount()
+    {
+        return $this->totalCount;
+    }
+
+    /**
+     * @param int $totalCount
+     */
+    public function setTotalCount($totalCount)
+    {
+        $this->totalCount = $totalCount;
+    }
 }

src/ModelSet.php

@@ -39,6 +39,16 @@ class ModelSet extends Model implements ReadInterface
      */
     public $limit = 25;
 
+    /**
+     * @var int
+     */
+    public $totalCount = 0;
+
+    /**
+     * @var bool
+     */
+    public $includeTotalCount = false;
+
     /**
      * @var bool
      */
@@ -175,4 +185,36 @@ public function setNoDefaultSorting($noDefaultSorting)
     {
         $this->noDefaultSorting = (bool) $noDefaultSorting;
     }
+
+    /**
+     * @return bool
+     */
+    public function isIncludeTotalCount()
+    {
+        return $this->includeTotalCount;
+    }
+
+    /**
+     * @param bool $includeTotalCount
+     */
+    public function setIncludeTotalCount($includeTotalCount)
+    {
+        $this->includeTotalCount = $includeTotalCount;
+    }
+
+    /**
+     * @return int
+     */
+    public function getTotalCount()
+    {
+        return $this->totalCount;
+    }
+
+    /**
+     * @param int $totalCount
+     */
+    public function setTotalCount($totalCount = 0)
+    {
+        $this->totalCount = $totalCount;
+    }
 }