FIX Make sure count is correct after filtering (#448)

Author: GuySartorelli

composer.json

@@ -27,7 +27,7 @@
     "require": {
         "php": "^8.1",
         "silverstripe/vendor-plugin": "^2",
-        "silverstripe/framework": "^5"
+        "silverstripe/framework": "^5.2"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6",

src/GridFieldConfigurablePaginator.php

@@ -46,6 +46,10 @@ class GridFieldConfigurablePaginator extends GridFieldPaginator
      */
     protected $pageSizes = array();
 
+    /**
+     * Used to make sure we only count the list once.
+     * Required because the parent class sets totalItems to 0 by default.
+     */
     private bool $haveCheckedCount = false;
 
     /**
@@ -264,6 +268,10 @@ public function getManipulatedData(GridField $gridField, SS_List $dataList)
         // Assign the GridField to the class so it can be used later in the request
         $this->setGridField($gridField);
 
+        // Update item count prior to limit. This ensures filtered lists have the correct count.
+        $this->totalItems = $dataList->count();
+        $this->haveCheckedCount = true;
+
         // Retain page sizes during actions provided by other components
         $state = $this->getGridPagerState();
         if (is_numeric($state->pageSize)) {

tests/GridFieldConfigurablePaginatorTest.php

@@ -6,7 +6,11 @@
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Forms\GridField\GridField_FormAction;
+use SilverStripe\Forms\GridField\GridFieldFilterHeader;
+use SilverStripe\Forms\GridField\GridFieldPaginator;
 use SilverStripe\ORM\ArrayList;
+use SilverStripe\ORM\Search\BasicSearchContext;
+use SilverStripe\View\ArrayData;
 use Symbiote\GridFieldExtensions\GridFieldConfigurablePaginator;
 
 class GridFieldConfigurablePaginatorTest extends SapphireTest
@@ -27,6 +31,7 @@ protected function setUp(): void
         }
 
         $this->gridField = GridField::create('Mock', null, $data);
+        $this->gridField->getConfig()->removeComponentsByType(GridFieldPaginator::class);
     }
 
     public function testGetTotalItems()
@@ -37,6 +42,18 @@ public function testGetTotalItems()
         $this->assertSame(130, $paginator->getTotalItems());
     }
 
+    public function testGetTotalItemsDuringFilter(): void
+    {
+        $paginator = new GridFieldConfigurablePaginator;
+        $this->gridField->getConfig()->addComponent($paginator);
+        $this->gridField->getConfig()->getComponentByType(GridFieldFilterHeader::class)
+            ->setSearchContext(new BasicSearchContext(ArrayData::class, ['ID']));
+        $this->gridField->State->GridFieldFilterHeader->Columns = ['ID' => '2'];
+        $this->gridField->getManipulatedList();
+
+        $this->assertSame(31, $paginator->getTotalItems());
+    }
+
     public function testGetFirstShown()
     {
         $paginator = new GridFieldConfigurablePaginator;