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

sonata-project · Jan 3, 2021 · e6090d0 · e6090d0
1 parent c68ea81
commit e6090d0
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 20 deletions.
diff --git a/src/Action/SearchAction.php b/src/Action/SearchAction.php
@@ -16,6 +16,7 @@
 use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Admin\BreadcrumbsBuilderInterface;
 use Sonata\AdminBundle\Admin\Pool;
+use Sonata\AdminBundle\Datagrid\PagerInterface;
 use Sonata\AdminBundle\Search\SearchHandler;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
@@ -114,7 +115,15 @@ public function __invoke(Request $request): Response
                 ];
             }
             $page = (int) $pager->getPage();
-            $total = (int) $pager->getNbResults();
+            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([

diff --git a/src/Datagrid/Pager.php b/src/Datagrid/Pager.php
@@ -222,7 +222,7 @@ public function getLinks($nbLinks = null)
      */
     public function haveToPaginate()
     {
-        return $this->getMaxPerPage() && $this->getNbResults() > $this->getMaxPerPage();
+        return $this->getMaxPerPage() && $this->countResults() > $this->getMaxPerPage();
     }
 
     /**
@@ -441,9 +441,21 @@ public function getLastIndice()
     }
 
     /**
+     * @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->countResults();
+    }
+
+    public function countResults(): int
     {
         return $this->nbResults;
     }
@@ -739,7 +751,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()
     {
@@ -748,7 +760,7 @@ public function count()
             __METHOD__
         ), E_USER_DEPRECATED);
 
-        return $this->getNbResults();
+        return $this->countResults();
     }
 
     /**
@@ -838,10 +850,17 @@ public function getQuery()
     /**
      * @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;
     }
 

diff --git a/src/Datagrid/PagerInterface.php b/src/Datagrid/PagerInterface.php
@@ -25,7 +25,7 @@
  * @method int                      getPreviousPage()
  * @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 +99,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
 //    /**

diff --git a/src/Datagrid/SimplePager.php b/src/Datagrid/SimplePager.php
@@ -64,6 +64,16 @@ public function __construct($maxPerPage = 10, $threshold = 1)
     }
 
     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()) {

diff --git a/src/Resources/views/Block/block_search_result.html.twig b/src/Resources/views/Block/block_search_result.html.twig
@@ -31,8 +31,8 @@ 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>
+                    {% if pager and (pager.countResults is defined ? pager.countResults() : pager.getNbResults()) > 0 %}
+                        <span class="badge">{{ 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>

diff --git a/src/Resources/views/Block/block_stats.html.twig b/src/Resources/views/Block/block_stats.html.twig
@@ -17,10 +17,10 @@ file that was distributed with this source code.
     <!-- small box -->
     <div class="small-box {{ settings.color }}">
         <div class="inner">
-            <h3>{{ pager.getNbResults() }}</h3>
+            <h3>{{ pager.countResults is defined ? pager.countResults() : pager.getNbResults() }}</h3>
             <p>
                 {% if translation_domain %}
-                    {{ settings.text|trans({'%count%': pager.getNbResults()}, translation_domain) }}
+                    {{ settings.text|trans({'%count%': pager.countResults is defined ? pager.countResults() : pager.getNbResults()}, translation_domain) }}
                 {% else %}
                     {{ settings.text }}
                 {% endif %}

diff --git a/tests/App/Datagrid/Pager.php b/tests/App/Datagrid/Pager.php
@@ -100,7 +100,7 @@ public function getResults(): array
         return $this->repository->all();
     }
 
-    public function getNbResults()
+    public function countResults(): int
     {
         return \count($this->getResults());
     }

diff --git a/tests/Datagrid/PagerTest.php b/tests/Datagrid/PagerTest.php
@@ -136,11 +136,14 @@ public function testGetMaxRecordLimit(): void
         $this->assertSame(99, $this->pager->getMaxRecordLimit());
     }
 
+    /**
+     * @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 +158,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 +296,7 @@ public function testHaveToPaginate(): void
         $this->pager->setMaxPerPage(10);
         $this->assertFalse($this->pager->haveToPaginate());
 
-        $this->callMethod($this->pager, 'setNbResults', [100]);
+        $this->setProperty($this->pager, 'nbResults', 100);
         $this->assertTrue($this->pager->haveToPaginate());
     }
 
@@ -417,7 +420,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 +445,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 +560,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 +593,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 +657,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 +773,12 @@ protected function callMethod($obj, string $name, array $args = [])
 
         return $method->invokeArgs($obj, $args);
     }
+
+    private function setProperty(object $obj, string $name, $value)
+    {
+        $class = new \ReflectionClass($obj);
+        $property = $class->getProperty($name);
+        $property->setAccessible(true);
+        $property->setValue($obj, $value);
+    }
 }
diff --git a/tests/Datagrid/SimplePagerTest.php b/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