Rename isRequired() method in PaginatorInterface to `isPagination…

…Required()` (#151)
yiisoft · Jan 8, 2024 · 408742d · 408742d
1 parent e2fd7e0
commit 408742d
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - New #150: Extract `withLimit()` from `ReadableDataInterface` into `LimitableDataInterface` (@vjik)
 - Enh #150: `PaginatorInterface` now extends `ReadableDataInterface` (@vjik)
+- Chg #151: Rename `isRequired()` method in `PaginatorInterface` to `isPaginationRequired()` (@vjik)
 
 ## 1.0.1 January 25, 2023
 

diff --git a/src/Paginator/KeysetPaginator.php b/src/Paginator/KeysetPaginator.php
@@ -245,7 +245,7 @@ public function isOnLastPage(): bool
         return !$this->hasNextPage;
     }
 
-    public function isRequired(): bool
+    public function isPaginationRequired(): bool
     {
         return !$this->isOnFirstPage() || !$this->isOnLastPage();
     }

diff --git a/src/Paginator/OffsetPaginator.php b/src/Paginator/OffsetPaginator.php
@@ -243,7 +243,7 @@ public function isOnLastPage(): bool
         return $this->currentPage === $this->getInternalTotalPages();
     }
 
-    public function isRequired(): bool
+    public function isPaginationRequired(): bool
     {
         return $this->getTotalPages() > 1;
     }

diff --git a/src/Paginator/PaginatorInterface.php b/src/Paginator/PaginatorInterface.php
@@ -130,5 +130,5 @@ public function isOnFirstPage(): bool;
      *
      * @return bool Whether pagination is required.
      */
-    public function isRequired(): bool;
+    public function isPaginationRequired(): bool;
 }
diff --git a/tests/Paginator/KeysetPaginatorTest.php b/tests/Paginator/KeysetPaginatorTest.php
@@ -393,7 +393,7 @@ public function testIsOnFirstPage(): void
         $paginator = (new KeysetPaginator($dataReader))->withPageSize(2);
 
         $this->assertTrue($paginator->isOnFirstPage());
-        $this->assertTrue($paginator->isRequired());
+        $this->assertTrue($paginator->isPaginationRequired());
     }
 
     public function testIsOnLastPage(): void
@@ -416,20 +416,20 @@ public function testIsOnLastPage(): void
 
         $paginator = $paginator->withNextPageToken('2');
         $this->assertFalse($paginator->isOnLastPage());
-        $this->assertTrue($paginator->isRequired());
+        $this->assertTrue($paginator->isPaginationRequired());
     }
 
-    public function testIsRequired(): void
+    public function testIsPaginationRequired(): void
     {
         $sort = Sort::only(['id'])->withOrderString('id');
         $dataReader = (new IterableDataReader($this->getDataSet()))->withSort($sort);
         $paginator = new KeysetPaginator($dataReader);
 
-        $this->assertFalse($paginator->isRequired());
+        $this->assertFalse($paginator->isPaginationRequired());
 
         $paginator = $paginator->withPageSize(2);
 
-        $this->assertTrue($paginator->isRequired());
+        $this->assertTrue($paginator->isPaginationRequired());
     }
 
     public function testCurrentPageSize(): void

diff --git a/tests/Paginator/OffsetPaginatorTest.php b/tests/Paginator/OffsetPaginatorTest.php
@@ -167,15 +167,15 @@ public function testDefaultState(): void
         $this->assertSame(0, $paginator->getOffset());
         $this->assertSame(1, $paginator->getCurrentPage());
         $this->assertTrue($paginator->isOnFirstPage());
-        $this->assertFalse($paginator->isRequired());
+        $this->assertFalse($paginator->isPaginationRequired());
     }
 
-    public function testIsRequired(): void
+    public function testIsPaginationRequired(): void
     {
         $dataReader = new IterableDataReader(self::DEFAULT_DATASET);
         $paginator = (new OffsetPaginator($dataReader))->withPageSize(2);
 
-        $this->assertTrue($paginator->isRequired());
+        $this->assertTrue($paginator->isPaginationRequired());
     }
 
     public function testGetTotalItems(): void
@@ -463,7 +463,7 @@ public function testEmptyDataSet(): void
         $this->assertSame(1, $paginator->getCurrentPage());
         $this->assertTrue($paginator->isOnFirstPage());
         $this->assertTrue($paginator->isOnLastPage());
-        $this->assertFalse($paginator->isRequired());
+        $this->assertFalse($paginator->isPaginationRequired());
         $this->assertSame([], $this->iterableToArray($paginator->read()));
     }