Optionally disable count for simple pagination (#1755)

* Add option for setShouldRetrieveTotalItemCountStatus * Fix styling --------- Co-authored-by: lrljoe <[email protected]>
rappasoft · Jul 1, 2024 · 3633743 · 3633743
1 parent 318bdeb
commit 3633743
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 7 deletions.
diff --git a/docs/pagination/available-methods.md b/docs/pagination/available-methods.md
@@ -263,3 +263,36 @@ public function configure(): void
     ]);
 }
 ```
+
+## setShouldRetrieveTotalItemCountStatus
+
+Used when "simple" pagination is being used, allows the enabling/disabling of the "total records" count.  This may be desirable to disable in larger data sets.  This is enabled by default.
+
+```php
+public function configure(): void
+{
+    $this->setShouldRetrieveTotalItemCountStatus(false);
+}
+```
+
+## setShouldRetrieveTotalItemCountEnabled
+
+Used when "simple" pagination is being used, enables the "total records" count.
+
+```php
+public function configure(): void
+{
+    $this->setShouldRetrieveTotalItemCountEnabled();
+}
+```
+
+## setShouldRetrieveTotalItemCountDisabled
+
+Used when "simple" pagination is being used, disables the "total records" count.
+
+```php
+public function configure(): void
+{
+    $this->setShouldRetrieveTotalItemCountDisabled();
+}
+```
diff --git a/src/Traits/Configuration/PaginationConfiguration.php b/src/Traits/Configuration/PaginationConfiguration.php
@@ -155,4 +155,26 @@ public function setPerPageFieldAttributes(array $attributes = []): self
 
         return $this;
     }
+
+    public function setShouldRetrieveTotalItemCountStatus(bool $status): self
+    {
+        $this->shouldRetrieveTotalItemCount = $status;
+
+        return $this;
+
+    }
+
+    public function setShouldRetrieveTotalItemCountEnabled(): self
+    {
+        $this->setShouldRetrieveTotalItemCountStatus(true);
+
+        return $this;
+    }
+
+    public function setShouldRetrieveTotalItemCountDisabled(): self
+    {
+        $this->setShouldRetrieveTotalItemCountStatus(false);
+
+        return $this;
+    }
 }
diff --git a/src/Traits/Helpers/PaginationHelpers.php b/src/Traits/Helpers/PaginationHelpers.php
@@ -149,4 +149,10 @@ public function getPerPageFieldAttributes(): array
     {
         return $this->perPageFieldAttributes;
     }
+
+    #[Computed]
+    public function getShouldRetrieveTotalItemCount(): bool
+    {
+        return $this->shouldRetrieveTotalItemCount;
+    }
 }
diff --git a/src/Traits/WithData.php b/src/Traits/WithData.php
@@ -80,21 +80,25 @@ protected function executeQuery(): Collection|CursorPaginator|Paginator|LengthAw
                 $this->paginationTotalItemCount = $paginatedResults->total() ?? 0;
 
                 return $paginatedResults;
-            }
-
-            if ($this->isPaginationMethod('simple')) {
+            } elseif ($this->isPaginationMethod('simple')) {
 
-                $this->paginationTotalItemCount = $this->getBuilder()->count();
+                if ($this->getShouldRetrieveTotalItemCount()) {
+                    $this->paginationTotalItemCount = $this->getBuilder()->count();
 
-                return $this->getBuilder()->simplePaginate($this->getPerPage() === -1 ? $this->paginationTotalItemCount : $this->getPerPage(), ['*'], $this->getComputedPageName());
+                    return $this->getBuilder()->simplePaginate($this->getPerPage() === -1 ? $this->paginationTotalItemCount : $this->getPerPage(), ['*'], $this->getComputedPageName());
+                } else {
+                    $this->paginationTotalItemCount = -1;
 
-            }
+                    return $this->getBuilder()->simplePaginate($this->getPerPage() === -1 ? 10 : $this->getPerPage(), ['*'], $this->getComputedPageName());
+                }
 
-            if ($this->isPaginationMethod('cursor')) {
+            } elseif ($this->isPaginationMethod('cursor')) {
 
                 $this->paginationTotalItemCount = $this->getBuilder()->count();
 
                 return $this->getBuilder()->cursorPaginate($this->getPerPage() === -1 ? $this->paginationTotalItemCount : $this->getPerPage(), ['*'], $this->getComputedPageName());
+            } else {
+                throw new DataTableConfigurationException('Pagination method must be either simple, standard or cursor');
             }
         }
 

diff --git a/src/Traits/WithPagination.php b/src/Traits/WithPagination.php
@@ -41,6 +41,8 @@ trait WithPagination
 
     protected array $perPageFieldAttributes = ['default-styling' => true, 'default-colors' => true, 'class' => ''];
 
+    protected bool $shouldRetrieveTotalItemCount = true;
+
     public function mountWithPagination(): void
     {
         $sessionPerPage = session()->get($this->getPerPagePaginationSessionKey(), $this->getPerPageAccepted()[0] ?? 10);

diff --git a/tests/Traits/Helpers/PaginationHelpersTest.php b/tests/Traits/Helpers/PaginationHelpersTest.php
@@ -141,4 +141,34 @@ public function test_can_get_pagination_field_attributes(): void
         $this->assertSame(['default-styling' => false, 'default-colors' => true, 'class' => 'bg-blue-500 dark:bg-red-500'], $this->basicTable->getPerPageFieldAttributes());
 
     }
+
+    public function test_can_toggle_total_item_count_retrieval(): void
+    {
+
+        $this->assertTrue($this->basicTable->getShouldRetrieveTotalItemCount());
+
+        $this->basicTable->setShouldRetrieveTotalItemCountDisabled();
+
+        $this->assertFalse($this->basicTable->getShouldRetrieveTotalItemCount());
+
+        $this->basicTable->setShouldRetrieveTotalItemCountEnabled();
+
+        $this->assertTrue($this->basicTable->getShouldRetrieveTotalItemCount());
+
+    }
+
+    public function test_can_toggle_total_item_count_retrieval_via_status(): void
+    {
+
+        $this->assertTrue($this->basicTable->getShouldRetrieveTotalItemCount());
+
+        $this->basicTable->setShouldRetrieveTotalItemCountStatus(false);
+
+        $this->assertFalse($this->basicTable->getShouldRetrieveTotalItemCount());
+
+        $this->basicTable->setShouldRetrieveTotalItemCountStatus(true);
+
+        $this->assertTrue($this->basicTable->getShouldRetrieveTotalItemCount());
+
+    }
 }