deprecate PagerInterface::getNbResults() in favour of countResults()

UPGRADE-3.x.md

@@ -1,6 +1,17 @@
 UPGRADE 3.x
 ===========
 
+UPGRADE FROM 3.85 to 3.86
+=========================
+
+### Sonata\AdminBundle\Datagrid\PagerInterface
+
+Deprecated `getNbResults()` method in favor of `countResults()`.
+
+### Sonata\AdminBundle\Datagrid\Pager and Sonata\AdminBundle\Datagrid\SimplePager
+
+Deprecated `$nbResults` property, `getNbResults()` and `setNbResults()` methods.
+
 UPGRADE FROM 3.83 to 3.84
 =========================
 

src/Action/SearchAction.php

@@ -114,7 +114,17 @@ public function __invoke(Request $request): Response
                 ];
             }
             $page = (int) $pager->getPage();
-            $total = (int) $pager->getNbResults();
+
+            // NEXT_MAJOR: remove the existence check and just use $pager->countResults() without casting to int
+            if (method_exists($pager, 'countResults')) {
+                $total = (int) $pager->countResults();
+            } else {
+                @trigger_error(sprintf(
+                    'Not implementing "%s::countResults()" is deprecated since sonata-project/admin-bundle 3.86 and will fail in 4.0.',
+                    'Sonata\AdminBundle\Datagrid\PagerInterface'
+                ), E_USER_DEPRECATED);
+                $total = (int) $pager->getNbResults();
+            }
         }
 
         $response = new JsonResponse([

src/Datagrid/Pager.php

@@ -40,6 +40,10 @@ abstract class Pager implements \Iterator, \Countable, \Serializable, PagerInter
     protected $lastPage = 1;
 
     /**
+     * NEXT_MAJOR: Remove this property.
+     *
+     * @deprecated since sonata-project/admin-bundle 3.86
+     *
      * @var int
      */
     protected $nbResults = 0;
@@ -222,7 +226,19 @@ public function getLinks($nbLinks = null)
      */
     public function haveToPaginate()
     {
-        return $this->getMaxPerPage() && $this->getNbResults() > $this->getMaxPerPage();
+        // NEXT_MAJOR: remove the existence check and just use $pager->countResults() without casting to int
+        if (method_exists($this, 'countResults')) {
+            $countResults = (int) $this->countResults();
+        } else {
+            @trigger_error(sprintf(
+                'Not implementing "%s::countResults()" is deprecated since sonata-project/admin-bundle 3.86 and will fail in 4.0.',
+                'Sonata\AdminBundle\Datagrid\PagerInterface'
+            ), E_USER_DEPRECATED);
+
+            $countResults = (int) $this->getNbResults();
+        }
+
+        return $this->getMaxPerPage() && $countResults > $this->getMaxPerPage();
     }
 
     /**
@@ -441,10 +457,19 @@ public function getLastIndice()
     }
 
     /**
+     * NEXT_MAJOR: remove this method.
+     *
+     * @deprecated since sonata-project/admin-bundle 3.86, use countResults instead
+     *
      * @return int
      */
     public function getNbResults()
     {
+        @trigger_error(sprintf(
+            'The method "%s()" is deprecated since sonata-project/admin-bundle 3.86 and will be removed in 4.0. Use countResults() instead.',
+            __METHOD__
+        ), E_USER_DEPRECATED);
+
         return $this->nbResults;
     }
 
@@ -739,7 +764,7 @@ public function valid()
     /**
      * NEXT_MAJOR: Remove this method.
      *
-     * @deprecated since sonata-project/admin-bundle 3.84, use getNbResults instead
+     * @deprecated since sonata-project/admin-bundle 3.84, use countResults instead
      */
     public function count()
     {
@@ -836,12 +861,21 @@ public function getQuery()
     }
 
     /**
+     * NEXT_MAJOR: remove this method.
+     *
      * @param int $nb
      *
+     * @deprecated since sonata-project/admin-bundle 3.86
+     *
      * @return void
      */
     protected function setNbResults($nb)
     {
+        @trigger_error(sprintf(
+            'The method "%s()" is deprecated since sonata-project/admin-bundle 3.86 and will be removed in 4.0.',
+            __METHOD__
+        ), E_USER_DEPRECATED);
+
         $this->nbResults = $nb;
     }
 

src/Datagrid/PagerInterface.php

@@ -26,6 +26,7 @@
  * @method bool                     isFirstPage()
  * @method bool                     isLastPage()
  * @method int                      getNbResults()
+ * @method int                      countResults()
  * @method array                    getLinks(?int $nbLinks = null)
  * @method bool                     haveToPaginate()
  * @method ProxyQueryInterface|null getQuery()
@@ -99,7 +100,7 @@ public function setQuery($query);
     public function getResults();
 
 //    NEXT_MAJOR: uncomment this method in 4.0
-//    public function getNbResults(): int;
+//    public function countResults(): int;
 
 //    NEXT_MAJOR: uncomment this method 4.0
 //    /**

src/Datagrid/SimplePager.php

@@ -63,7 +63,20 @@ public function __construct($maxPerPage = 10, $threshold = 1)
         $this->setThreshold($threshold);
     }
 
+    /**
+     * NEXT_MAJOR: remove this method.
+     */
     public function getNbResults()
+    {
+        @trigger_error(sprintf(
+            'The method "%s()" is deprecated since sonata-project/admin-bundle 3.86 and will be removed in 4.0. Use countResults() instead.',
+            __METHOD__
+        ), E_USER_DEPRECATED);
+
+        return $this->countResults();
+    }
+
+    public function countResults(): int
     {
         $n = ($this->getLastPage() - 1) * $this->getMaxPerPage();
         if ($this->getLastPage() === $this->getPage()) {

src/Resources/views/Block/block_search_result.html.twig

@@ -31,8 +31,10 @@ file that was distributed with this source code.
                 </h3>
 
                 <div class="box-tools pull-right">
-                    {% if pager and pager.getNbResults() > 0 %}
-                        <span class="badge">{{ pager.getNbResults() }}</span>
+                    {# NEXT_MAJOR: remove the attribute check and just use .countResults() #}
+                    {% if pager and (attribute(pager, 'countResults') is defined ? pager.countResults() : pager.getNbResults()) > 0 %}
+                        {# NEXT_MAJOR: remove the attribute check and just use .countResults() #}
+                        <span class="badge">{{ (attribute(pager, 'countResults') is defined ? pager.countResults() : pager.getNbResults()) }}</span>
                     {% elseif admin.hasRoute('create') and admin.hasAccess('create') %}
                         <a href="{{ admin.generateUrl('create') }}" class="btn btn-box-tool">
                             <i class="fa fa-plus" aria-hidden="true"></i>

src/Resources/views/Block/block_stats.html.twig

@@ -17,10 +17,12 @@ file that was distributed with this source code.
     <!-- small box -->
     <div class="small-box {{ settings.color }}">
         <div class="inner">
-            <h3>{{ pager.getNbResults() }}</h3>
+            {# NEXT_MAJOR: remove the attribute check and just use .countResults() #}
+            <h3>{{ attribute(pager, 'countResults') is defined ? pager.countResults() : pager.getNbResults() }}</h3>
             <p>
                 {% if translation_domain %}
-                    {{ settings.text|trans({'%count%': pager.getNbResults()}, translation_domain) }}
+                    {# NEXT_MAJOR: remove the attribute check and just use .countResults() #}
+                    {{ settings.text|trans({'%count%': attribute(pager, 'countResults') is defined ? pager.countResults() : pager.getNbResults()}, translation_domain) }}
                 {% else %}
                     {{ settings.text }}
                 {% endif %}

tests/App/Datagrid/Pager.php

@@ -100,7 +100,15 @@ public function getResults(): array
         return $this->repository->all();
     }
 
-    public function getNbResults()
+    /**
+     * NEXT_MAJOR: remove this method.
+     */
+    public function getNbResults(): int
+    {
+        return $this->countResults();
+    }
+
+    public function countResults(): int
     {
         return \count($this->getResults());
     }

tests/Datagrid/PagerTest.php

@@ -32,7 +32,15 @@ class PagerTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->pager = $this->getMockForAbstractClass(Pager::class);
+        $this->pager = $this->getMockForAbstractClass(
+            Pager::class,
+            [],
+            '',
+            true,
+            true,
+            true,
+            ['countResults']
+        );
     }
 
     /**
@@ -136,11 +144,16 @@ public function testGetMaxRecordLimit(): void
         $this->assertSame(99, $this->pager->getMaxRecordLimit());
     }
 
+    /**
+     * NEXT_MAJOR: Remove this test.
+     *
+     * @group legacy
+     */
     public function testGetNbResults(): void
     {
         $this->assertSame(0, $this->pager->getNbResults());
 
-        $this->callMethod($this->pager, 'setNbResults', [100]);
+        $this->setProperty($this->pager, 'nbResults', 100);
 
         $this->assertSame(100, $this->pager->getNbResults());
     }
@@ -155,7 +168,7 @@ public function testCount(): void
         $this->expectDeprecation('The method "Sonata\AdminBundle\Datagrid\Pager::count()" is deprecated since sonata-project/admin-bundle 3.84 and will be removed in 4.0.');
         $this->assertSame(0, $this->pager->count());
 
-        $this->callMethod($this->pager, 'setNbResults', [100]);
+        $this->setProperty($this->pager, 'nbResults', 100);
 
         $this->assertSame(100, $this->pager->count());
     }
@@ -293,7 +306,11 @@ public function testHaveToPaginate(): void
         $this->pager->setMaxPerPage(10);
         $this->assertFalse($this->pager->haveToPaginate());
 
-        $this->callMethod($this->pager, 'setNbResults', [100]);
+        $this->pager->expects($this->once())
+            ->method('countResults')
+            ->willReturn(100)
+        ;
+
         $this->assertTrue($this->pager->haveToPaginate());
     }
 
@@ -417,7 +434,7 @@ public function testGetCursor(): void
         $this->pager->setCursor(300);
         $this->assertSame(0, $this->pager->getCursor());
 
-        $this->callMethod($this->pager, 'setNbResults', [100]);
+        $this->setProperty($this->pager, 'nbResults', 100);
 
         $this->pager->setCursor(5);
         $this->assertSame(5, $this->pager->getCursor());
@@ -442,7 +459,7 @@ public function testGetObjectByCursor(): void
         $object3 = new \stdClass();
         $object3->foo = 'bar3';
 
-        $this->callMethod($this->pager, 'setNbResults', [3]);
+        $this->setProperty($this->pager, 'nbResults', 3);
 
         $query = $this->createMock(ProxyQueryInterface::class);
 
@@ -557,7 +574,7 @@ public function testGetLastIndex(): void
         $this->pager->setPage(0);
         $this->assertSame(0, $this->pager->getLastIndex());
 
-        $this->callMethod($this->pager, 'setNbResults', [100]);
+        $this->setProperty($this->pager, 'nbResults', 100);
 
         $this->assertSame(100, $this->pager->getLastIndex());
 
@@ -590,7 +607,7 @@ public function testGetNext(): void
         $object3 = new \stdClass();
         $object3->foo = 'bar3';
 
-        $this->callMethod($this->pager, 'setNbResults', [3]);
+        $this->setProperty($this->pager, 'nbResults', 3);
 
         $query = $this->createMock(ProxyQueryInterface::class);
 
@@ -654,7 +671,7 @@ public function testGetPrevious(): void
         $object3 = new \stdClass();
         $object3->foo = 'bar3';
 
-        $this->callMethod($this->pager, 'setNbResults', [3]);
+        $this->setProperty($this->pager, 'nbResults', 3);
 
         $query = $this->createMock(ProxyQueryInterface::class);
 
@@ -770,4 +787,15 @@ protected function callMethod($obj, string $name, array $args = [])
 
         return $method->invokeArgs($obj, $args);
     }
+
+    /**
+     * NEXT_MAJOR: remove this method.
+     */
+    private function setProperty(object $obj, string $name, $value): void
+    {
+        $class = new \ReflectionClass($obj);
+        $property = $class->getProperty($name);
+        $property->setAccessible(true);
+        $property->setValue($obj, $value);
+    }
 }

tests/Datagrid/SimplePagerTest.php

@@ -115,7 +115,7 @@ public function testNoPagesForNoResults(): void
         $this->pager->setQuery($this->proxyQuery);
         $this->pager->init();
         $this->assertSame(1, $this->pager->getLastPage());
-        $this->assertSame(0, $this->pager->getNbResults());
+        $this->assertSame(0, $this->pager->countResults());
     }
 
     public function testInitNoQuery(): void