Merge pull request #2489 from MashinaMashina/fix_pager

Fix pager
codeigniter4 · Jan 22, 2020 · fd56585 · fd56585
2 parents 83fc7ea + 309afd1
commit fd56585
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 43 deletions.
diff --git a/system/Model.php b/system/Model.php
@@ -1122,14 +1122,13 @@ public function chunk(int $size, Closure $userFunc)
 	 */
 	public function paginate(int $perPage = 20, string $group = 'default', int $page = 0)
 	{
-		// Get the necessary parts.
-		$page = $page >= 1 ? $page : (ctype_digit($_GET['page'] ?? '') && $_GET['page'] > 1 ? $_GET['page'] : 1);
-
+		$pager = \Config\Services::pager(null, null, false);
+		$page = $page >= 1 ? $page : $pager->getCurrentPage($group);
+		
 		$total = $this->countAllResults(false);
 
 		// Store it in the Pager library so it can be
 		// paginated in the views.
-		$pager       = \Config\Services::pager();
 		$this->pager = $pager->store($group, $page, $perPage, $total);
 
 		$offset = ($page - 1) * $perPage;

diff --git a/system/Pager/Pager.php b/system/Pager/Pager.php
@@ -348,7 +348,7 @@ public function getPageURI(int $page = null, string $group = 'default', bool $re
 		}
 		else
 		{
-			$uri->addQuery('page', $page);
+			$uri->addQuery($this->groups[$group]['pageSelector'], $page);
 		}
 
 		if ($this->only)
@@ -357,7 +357,7 @@ public function getPageURI(int $page = null, string $group = 'default', bool $re
 
 			if (! $segment)
 			{
-				$query['page'] = $page;
+				$query[$this->groups[$group]['pageSelector']] = $page;
 			}
 
 			$uri->setQueryArray($query);
@@ -503,13 +503,31 @@ protected function ensureGroup(string $group)
 		}
 
 		$this->groups[$group] = [
-			'uri'       => clone Services::request()->uri,
-			'hasMore'   => false,
-			'total'     => null,
-			'perPage'   => $this->config->perPage,
-			'pageCount' => 1,
+			'uri'          => clone Services::request()->uri,
+			'hasMore'      => false,
+			'total'        => null,
+			'perPage'      => $this->config->perPage,
+			'pageCount'    => 1,
+			'pageSelector' => $group === 'default' ? 'page' : 'page_' . $group,
 		];
 
+		$this->calculateCurrentPage($group);
+
+		if ($_GET)
+		{
+			$this->groups[$group]['uri'] = $this->groups[$group]['uri']->setQueryArray($_GET);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Calculating the current page
+	 *
+	 * @param string $group
+	 */
+	protected function calculateCurrentPage(string $group)
+	{
 		if (array_key_exists($group, $this->segment))
 		{
 			try
@@ -523,12 +541,11 @@ protected function ensureGroup(string $group)
 		}
 		else
 		{
-			$this->groups[$group]['currentPage'] = $_GET['page_' . $group] ?? $_GET['page'] ?? 1;
-		}
+			$pageSelector = $this->groups[$group]['pageSelector'];
 
-		if ($_GET)
-		{
-			$this->groups[$group]['uri'] = $this->groups[$group]['uri']->setQueryArray($_GET);
+			$page = (int) ($_GET[$pageSelector] ?? 1);
+
+			$this->groups[$group]['currentPage']  = $page < 1 ? 1 : $page;
 		}
 	}
 

diff --git a/system/Pager/PagerRenderer.php b/system/Pager/PagerRenderer.php
@@ -93,7 +93,13 @@ class PagerRenderer
 	 * @var integer
 	 */
 	protected $segment;
-
+	/**
+	 * Name of $_GET parameter
+	 *
+	 * @var integer
+	 */
+	protected $pageSelector;
+
 	//--------------------------------------------------------------------
 
 	/**
@@ -103,13 +109,14 @@ class PagerRenderer
 	 */
 	public function __construct(array $details)
 	{
-		$this->first     = 1;
-		$this->last      = $details['pageCount'];
-		$this->current   = $details['currentPage'];
-		$this->total     = $details['total'];
-		$this->uri       = $details['uri'];
-		$this->pageCount = $details['pageCount'];
-		$this->segment   = $details['segment'] ?? 0;
+		$this->first        = 1;
+		$this->last         = $details['pageCount'];
+		$this->current      = $details['currentPage'];
+		$this->total        = $details['total'];
+		$this->uri          = $details['uri'];
+		$this->pageCount    = $details['pageCount'];
+		$this->segment      = $details['segment'] ?? 0;
+		$this->pageSelector = $details['pageSelector'] ?? 'page';
 	}
 
 	//--------------------------------------------------------------------
@@ -164,7 +171,7 @@ public function getPrevious()
 
 		if ($this->segment === 0)
 		{
-			$uri->addQuery('page', $this->first - 1);
+			$uri->addQuery($this->pageSelector, $this->first - 1);
 		}
 		else
 		{
@@ -208,7 +215,7 @@ public function getNext()
 
 		if ($this->segment === 0)
 		{
-			$uri->addQuery('page', $this->last + 1);
+			$uri->addQuery($this->pageSelector, $this->last + 1);
 		}
 		else
 		{
@@ -231,7 +238,7 @@ public function getFirst(): string
 
 		if ($this->segment === 0)
 		{
-			$uri->addQuery('page', 1);
+			$uri->addQuery($this->pageSelector, 1);
 		}
 		else
 		{
@@ -254,7 +261,7 @@ public function getLast(): string
 
 		if ($this->segment === 0)
 		{
-			$uri->addQuery('page', $this->pageCount);
+			$uri->addQuery($this->pageSelector, $this->pageCount);
 		}
 		else
 		{
@@ -277,7 +284,7 @@ public function getCurrent(): string
 
 		if ($this->segment === 0)
 		{
-			$uri->addQuery('page', $this->current);
+			$uri->addQuery($this->pageSelector, $this->current);
 		}
 		else
 		{
@@ -306,7 +313,7 @@ public function links(): array
 		for ($i = $this->first; $i <= $this->last; $i ++)
 		{
 			$links[] = [
-				'uri'    => (string) ($this->segment === 0 ? $uri->addQuery('page', $i) : $uri->setSegment($this->segment, $i)),
+				'uri'    => (string) ($this->segment === 0 ? $uri->addQuery($this->pageSelector, $i) : $uri->setSegment($this->segment, $i)),
 				'title'  => (int) $i,
 				'active' => ($i === $this->current),
 			];

diff --git a/tests/system/Pager/PagerTest.php b/tests/system/Pager/PagerTest.php
@@ -203,12 +203,12 @@ public function testGetTotalPagesCalcsCorrectValue()
 
 	public function testGetNextURIUsesCurrentURI()
 	{
-		$_GET['page'] = 2;
+		$_GET['page_foo'] = 2;
 
 		$this->pager->store('foo', 2, 12, 70);
 
 		$expected = current_url(true);
-		$expected = (string)$expected->setQuery('page=3');
+		$expected = (string)$expected->setQuery('page_foo=3');
 
 		$this->assertEquals((string)$expected, $this->pager->getNextPageURI('foo'));
 	}
@@ -225,19 +225,19 @@ public function testGetNextURICorrectOnFirstPage()
 		$this->pager->store('foo', 1, 12, 70);
 
 		$expected = current_url(true);
-		$expected = (string)$expected->setQuery('page=2');
+		$expected = (string)$expected->setQuery('page_foo=2');
 
 		$this->assertEquals($expected, $this->pager->getNextPageURI('foo'));
 	}
 
 	public function testGetPreviousURIUsesCurrentURI()
 	{
-		$_GET['page'] = 2;
+		$_GET['page_foo'] = 2;
 
 		$this->pager->store('foo', 2, 12, 70);
 
 		$expected = current_url(true);
-		$expected = (string)$expected->setQuery('page=1');
+		$expected = (string)$expected->setQuery('page_foo=1');
 
 		$this->assertEquals((string)$expected, $this->pager->getPreviousPageURI('foo'));
 	}
@@ -252,28 +252,28 @@ public function testGetNextURIReturnsNullOnFirstPage()
 	public function testGetNextURIWithQueryStringUsesCurrentURI()
 	{
 		$_GET = [
-			'page'   => 3,
-			'status' => 1,
+			'page_foo' => 3,
+			'status'   => 1,
 		];
 
 		$expected = current_url(true);
 		$expected = (string)$expected->setQueryArray($_GET);
 
-		$this->pager->store('foo', $_GET['page'] - 1, 12, 70);
+		$this->pager->store('foo', $_GET['page_foo'] - 1, 12, 70);
 
 		$this->assertEquals((string)$expected, $this->pager->getNextPageURI('foo'));
 	}
 
 	public function testGetPreviousURIWithQueryStringUsesCurrentURI()
 	{
 		$_GET     = [
-			'page'   => 1,
-			'status' => 1,
+			'page_foo' => 1,
+			'status'   => 1,
 		];
 		$expected = current_url(true);
 		$expected = (string)$expected->setQueryArray($_GET);
 
-		$this->pager->store('foo', $_GET['page'] + 1, 12, 70);
+		$this->pager->store('foo', $_GET['page_foo'] + 1, 12, 70);
 
 		$this->assertEquals((string)$expected, $this->pager->getPreviousPageURI('foo'));
 	}
@@ -383,12 +383,12 @@ public function testBasedURI()
 		$this->config = new Pager();
 		$this->pager  = new \CodeIgniter\Pager\Pager($this->config, Services::renderer());
 
-		$_GET['page'] = 2;
+		$_GET['page_foo'] = 2;
 
 		$this->pager->store('foo', 2, 12, 70);
 
 		$expected = current_url(true);
-		$expected = (string)$expected->setQuery('page=1');
+		$expected = (string)$expected->setQuery('page_foo=1');
 
 		$this->assertEquals((string)$expected, $this->pager->getPreviousPageURI('foo'));
 	}