extract pager constructor

juliangut · Jan 23, 2017 · 86039ef · 86039ef
1 parent a5b3373
commit 86039ef
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 34 deletions.
diff --git a/src/MongoDBRepository.php b/src/MongoDBRepository.php
@@ -82,6 +82,8 @@ public function findPagedBy($criteria, array $orderBy = null, $limit = 10, $offs
      *
      * @param array|Builder $criteria
      *
+     * @throws \InvalidArgumentException
+     *
      * @return int
      */
     public function countBy($criteria)

diff --git a/src/Pager/DefaultPager.php b/src/Pager/DefaultPager.php
@@ -37,44 +37,37 @@ class DefaultPager extends ArrayCollection implements Pager
      *
      * @var int
      */
-    protected $pageSize;
+    protected $pageCount;
 
     /**
      * Total number of elements.
      *
      * @var int
      */
-    protected $totalSize;
+    protected $totalCount;
 
     /**
      * {@inheritdoc}
      *
      * @throws \OutOfBoundsException
      */
-    public function __construct(array $elements, $page = 1, $pageSize = 10, $totalSize = 0)
+    public function __construct(array $elements, $currentPage = 1, $pageCount = 10, $totalCount = 0)
     {
-        if ((int) $pageSize < 1) {
-            throw new \OutOfBoundsException(sprintf('Page size must be at least 1. %d given', $pageSize));
-        }
-        $this->pageSize = (int) $pageSize;
-
-        if ((int) $page < 1) {
-            throw new \OutOfBoundsException(sprintf('Page can not be lower than 1. %s given', $page));
-        }
-        $this->currentPage = (int) $page;
+        $this->setCurrentPage($currentPage);
+        $this->setPageCount($pageCount);
 
-        $elements = array_slice($elements, 0, $this->pageSize);
+        $elements = array_slice($elements, 0, $this->pageCount);
 
-        if ((int) $totalSize < 1) {
-            $totalSize = count($elements);
+        if ((int) $totalCount < 1) {
+            $totalCount = count($elements);
         }
-        $this->totalSize = (int) $totalSize;
+        $this->totalCount = (int) $totalCount;
 
-        $this->totalPages = max(1, (int) ceil($this->totalSize / $this->pageSize));
+        $this->totalPages = max(1, (int) ceil($this->totalCount / $this->pageCount));
 
         if ($this->currentPage > $this->totalPages) {
             throw new \OutOfBoundsException(sprintf(
-                'Page can not be higher than %d. %d given',
+                'Current page can not be higher than %d. %d given',
                 $this->totalPages,
                 $this->currentPage
             ));
@@ -83,6 +76,38 @@ public function __construct(array $elements, $page = 1, $pageSize = 10, $totalSi
         parent::__construct($elements);
     }
 
+    /**
+     * Set current page.
+     *
+     * @param int $currentPage
+     *
+     * @throws \OutOfBoundsException
+     */
+    protected function setCurrentPage($currentPage)
+    {
+        if ((int) $currentPage < 1) {
+            throw new \OutOfBoundsException(sprintf('Current page can not be lower than 1. %s given', $currentPage));
+        }
+
+        $this->currentPage = (int) $currentPage;
+    }
+
+    /**
+     * Set pager page size.
+     *
+     * @param int $pageCount
+     *
+     * @throws \OutOfBoundsException
+     */
+    protected function setPageCount($pageCount)
+    {
+        if ((int) $pageCount < 1) {
+            throw new \OutOfBoundsException(sprintf('Page count must be at least 1. %d given', $pageCount));
+        }
+
+        $this->pageCount = (int) $pageCount;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -96,15 +121,15 @@ public function getCurrentPage()
      */
     public function getCurrentPageOffsetStart()
     {
-        return ($this->currentPage - 1) * $this->pageSize;
+        return ($this->currentPage - 1) * $this->pageCount;
     }
 
     /**
      * {@inheritdoc}
      */
     public function getCurrentPageOffsetEnd()
     {
-        return min($this->totalSize, $this->getCurrentPageOffsetStart() + $this->pageSize);
+        return min($this->totalCount, $this->getCurrentPageOffsetStart() + $this->pageCount);
     }
 
     /**
@@ -142,9 +167,9 @@ public function isLastPage()
     /**
      * {@inheritdoc}
      */
-    public function getPageSize()
+    public function getPageCount()
     {
-        return $this->pageSize;
+        return $this->pageCount;
     }
 
     /**
@@ -160,6 +185,6 @@ public function getTotalPages()
      */
     public function getTotalCount()
     {
-        return $this->totalSize;
+        return $this->totalCount;
     }
 }
diff --git a/src/Pager/Pager.php b/src/Pager/Pager.php
@@ -20,11 +20,11 @@ interface Pager extends \Countable, \IteratorAggregate
      * Page constructor.
      *
      * @param array $elements
-     * @param int   $page
-     * @param int   $pageSize
-     * @param int   $totalSize
+     * @param int   $currentPage
+     * @param int   $pageCount
+     * @param int   $totalCount
      */
-    public function __construct(array $elements, $page = 1, $pageSize = 10, $totalSize = 0);
+    public function __construct(array $elements, $currentPage = 1, $pageCount = 10, $totalCount = 0);
 
     /**
      * Get current page.
@@ -80,7 +80,7 @@ public function isLastPage();
      *
      * @return int
      */
-    public function getPageSize();
+    public function getPageCount();
 
     /**
      * Get total number of pages.

diff --git a/src/RelationalRepository.php b/src/RelationalRepository.php
@@ -110,6 +110,8 @@ public function findPagedBy($criteria, array $orderBy = null, $limit = 10, $offs
      *
      * @param array|QueryBuilder $criteria
      *
+     * @throws \InvalidArgumentException
+     *
      * @return int
      */
     public function countBy($criteria)

diff --git a/tests/Repository/Pager/DefaultPageTest.php b/tests/Repository/Pager/DefaultPageTest.php
@@ -22,7 +22,7 @@ class DefaultPageTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @expectedException \OutOfBoundsException
-     * @expectedExceptionMessageRegExp /^Page can not be lower than 1. 0 given/
+     * @expectedExceptionMessageRegExp /^Current page can not be lower than 1. 0 given/
      */
     public function testBadPageLowerLimit()
     {
@@ -31,7 +31,7 @@ public function testBadPageLowerLimit()
 
     /**
      * @expectedException \OutOfBoundsException
-     * @expectedExceptionMessageRegExp /^Page can not be higher than 1. 2 given/
+     * @expectedExceptionMessageRegExp /^Current page can not be higher than 1. 2 given/
      */
     public function testBadPageUpperLimit()
     {
@@ -40,18 +40,18 @@ public function testBadPageUpperLimit()
 
     /**
      * @expectedException \OutOfBoundsException
-     * @expectedExceptionMessageRegExp /^Page size must be at least 1. 0 given/
+     * @expectedExceptionMessageRegExp /^Page count must be at least 1. 0 given/
      */
-    public function testBadPageSize()
+    public function testBadPageCount()
     {
-        new DefaultPager([], 0, 0);
+        new DefaultPager([], 1, 0);
     }
 
     public function testPage()
     {
         $page = new DefaultPager(['a', 'b', 'c', 'd'], 1, 4, 12);
 
-        static::assertEquals(4, $page->getPageSize());
+        static::assertEquals(4, $page->getPageCount());
         static::assertEquals(12, $page->getTotalCount());
 
         static::assertEquals(1, $page->getCurrentPage());