Merge pull request #20 from CottaCush/features/report-pagination

(Reports): Implement pagination on reports
CottaCush · May 7, 2019 · da7de34 · da7de34
2 parents 4951484 + 57499ed
commit da7de34
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 12 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/controllers/DefaultController.php b/src/controllers/DefaultController.php
@@ -19,6 +19,7 @@
 class DefaultController extends BaseReportsController
 {
     const SQL_QUERY_KEY = '_sql_query_';
+    const SQL_RESULT_COUNT_KEY = '_sql_result_count_';
 
     /**
      * @author Taiwo Ladipo <[email protected]>
@@ -67,10 +68,13 @@ public function actionIndex()
 
     /**
      * @author Olawale Lawal <[email protected]>
+     * @author Taiwo Ladipo <[email protected]>
      * @param null $id
+     * @param null $page
      * @return string|\yii\web\Response
+     * @throws \CottaCush\Cricket\Exceptions\SQLQueryGenerationException
      */
-    public function actionView($id = null)
+    public function actionView($id = null, $page = null)
     {
         $reportId = Utils::decodeId($id);
 
@@ -85,10 +89,21 @@ public function actionView($id = null)
         }
 
         $data = [];
+        $paginationExtras = ['paginate' => true];
         $placeholderValues = $this->getRequest()->post();
 
         try {
             $parser = new SQLQueryBuilderParser();
+            if ($page) {
+                $paginationExtras['page'] = $page;
+                $paginationExtras['query_string'] = $this->getSession()->get(self::SQL_QUERY_KEY . $id);
+                $count = $this->getSession()->get(self::SQL_RESULT_COUNT_KEY . $id);
+            }
+            $data = $parser->parse($report, $placeholderValues, null, null, $paginationExtras);
+            if (!$page) {
+                $count = ArrayHelper::getValue($data, 'count');
+                $this->getSession()->set(self::SQL_RESULT_COUNT_KEY . $id, $count);
+            }
             $data = $parser->parse($report, $placeholderValues);
         } catch (SQLReportGenerationException $ex) {
             return $this->render('error', ['report' => $report, 'details' => $ex->getMessage()]);
@@ -98,11 +113,13 @@ public function actionView($id = null)
 
         return $this->render('view', [
             'report' => $report,
-            'data' => $data,
+            'data' => ArrayHelper::getValue($data, 'data'),
             'hasPlaceholders' => $parser->hasInputPlaceholders(),
             'encodedId' => $id,
             'hasPlaceholdersReplaced' => $parser->arePlaceholdersReplaced(),
             'values' => $placeholderValues,
+            'count' => $count,
+            'page' => $page
         ]);
     }
 

diff --git a/src/models/Report.php b/src/models/Report.php
@@ -2,7 +2,9 @@
 
 namespace CottaCush\Cricket\Report\Models;
 
+use CottaCush\Cricket\Generators\SQL\SQLGenerator;
 use CottaCush\Cricket\Interfaces\CricketQueryableInterface;
+use CottaCush\Cricket\Models\Query;
 use CottaCush\Cricket\Report\Libs\Utils;
 
 /**
@@ -19,6 +21,7 @@
 class Report extends BaseReportsModel implements CricketQueryableInterface
 {
 
+    const PAGE_LIMIT = SQLGenerator::QUERY_LIMIT;
     /**
      * {@inheritdoc}
      */

diff --git a/src/views/default/view.php b/src/views/default/view.php
@@ -31,7 +31,7 @@
 } else {
     echo ReportTableWidget::widget([
         'data' => $data, 'report' => $report, 'hasPlaceholders' => $hasPlaceholders, 'placeholderValues' => $values,
-        'excludeBootstrapAssets' => $excludeBootstrapAssets
+        'excludeBootstrapAssets' => $excludeBootstrapAssets, 'count' => $count, 'page' => $page
     ]);
 }
 echo Html::endTag('div');
diff --git a/src/widgets/ReportTableWidget.php b/src/widgets/ReportTableWidget.php
@@ -4,10 +4,13 @@
 
 use CottaCush\Cricket\Interfaces\CricketQueryableInterface;
 use CottaCush\Cricket\Report\Libs\Utils;
+use CottaCush\Cricket\Report\Models\Report;
 use CottaCush\Yii2\Helpers\Html;
 use CottaCush\Yii2\Widgets\EmptyStateWidget;
+use yii\data\Pagination;
 use yii\helpers\ArrayHelper;
 use yii\helpers\Url;
+use yii\widgets\LinkPager;
 
 /**
  * Class ReportTableWidget
@@ -24,7 +27,8 @@ class ReportTableWidget extends BaseReportsWidget
     public $tableClasses = 'table table-striped table-bordered';
 
     public $emptyResultMsg = 'The query returned an empty data set';
-    private $noOfRecords;
+    public $count;
+    public $page = null;
 
     public $hasPlaceholders = false;
     private $hasResults;
@@ -37,8 +41,7 @@ class ReportTableWidget extends BaseReportsWidget
 
     public function init()
     {
-        $this->noOfRecords = count($this->data);
-        $this->hasResults = (bool)$this->noOfRecords;
+        $this->hasResults = (bool)$this->count;
 
         parent::init();
     }
@@ -61,6 +64,7 @@ public function run()
         }
 
         $this->renderTable();
+        $this->renderPagination();
     }
 
     private function renderTable()
@@ -121,12 +125,36 @@ private function renderResultCount()
 
         echo Html::tag(
             'b',
-            $this->noOfRecords . ' record' . ($this->noOfRecords == 1 ? '' : 's') . ' returned'
+            $this->getDataSummary()
         );
 
         echo $this->endDiv();
     }
 
+    private function getDataSummary()
+    {
+        $limit = Report::PAGE_LIMIT;
+        $msgTemplate = 'Showing %s &ndash; %s of %s items';
+        $msg = sprintf($msgTemplate, 1, $this->count, $this->count);
+        if ($this->count > $limit && $this->page) {
+            $start = ($this->page - 1) * $limit + 1;
+            $end = ($this->page * $limit);
+            $pageTotal = ($end <= $this->count) ? $end : $this->count;
+            $msg = sprintf($msgTemplate, $start, $pageTotal, $this->count);
+        }
+        return $msg;
+    }
+
+    private function renderPagination()
+    {
+        echo LinkPager::widget([
+            'pagination' => new Pagination([
+                'totalCount' => $this->count,
+                'pageSize' => Report::PAGE_LIMIT
+            ])
+        ]);
+    }
+
     /**
      * @author Olawale Lawal <[email protected]>
      */
@@ -167,7 +195,7 @@ public function renderButtons()
         if ($this->hasPlaceholders) {
             echo SQLReportFilterModalWidget::widget([
                 'id' => $this->editFilterModalId, 'model' => $this->report, 'data' => $this->placeholderValues,
-                'route' => Url::current(), 'database' => $this->database,
+                'route' => Url::current(['page' => null]), 'database' => $this->database,
                 'excludeBootstrapAssets' => $this->excludeBootstrapAssets
             ]);
         }