Merge pull request #6596 from ddevsr/docs-pager

codeigniter4 · Sep 28, 2022 · c89ba56 · c89ba56
2 parents 8a93b65 + 23be5bf
commit c89ba56
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 10 deletions.
diff --git a/system/Pager/Pager.php b/system/Pager/Pager.php
@@ -158,7 +158,7 @@ public function store(string $group, int $page, ?int $perPage, int $total, int $
     /**
      * Sets segment for a group.
      *
-     * @return mixed
+     * @return $this
      */
     public function setSegment(int $number, string $group = 'default')
     {
@@ -174,7 +174,7 @@ public function setSegment(int $number, string $group = 'default')
     /**
      * Sets the path that an aliased group of links will use.
      *
-     * @return mixed
+     * @return $this
      */
     public function setPath(string $path, string $group = 'default')
     {

diff --git a/system/Pager/PagerInterface.php b/system/Pager/PagerInterface.php
@@ -42,14 +42,14 @@ public function makeLinks(int $page, int $perPage, int $total, string $template
      * Stores a set of pagination data for later display. Most commonly used
      * by the model to automate the process.
      *
-     * @return mixed
+     * @return $this
      */
     public function store(string $group, int $page, int $perPage, int $total);
 
     /**
      * Sets the path that an aliased group of links will use.
      *
-     * @return mixed
+     * @return $this
      */
     public function setPath(string $path, string $group = 'default');
 

diff --git a/tests/system/Pager/PagerTest.php b/tests/system/Pager/PagerTest.php
@@ -18,7 +18,7 @@
 use CodeIgniter\Pager\Exceptions\PagerException;
 use CodeIgniter\Test\CIUnitTestCase;
 use Config\App;
-use Config\Pager;
+use Config\Pager as PagerConfig;
 use Config\Services;
 
 /**
@@ -28,7 +28,7 @@
  */
 final class PagerTest extends CIUnitTestCase
 {
-    private ?\CodeIgniter\Pager\Pager $pager = null;
+    private ?Pager $pager = null;
     private $config;
 
     protected function setUp(): void
@@ -58,8 +58,8 @@ private function createPager(string $requestUri): void
         $request = $request->withMethod('GET');
         Services::injectMock('request', $request);
 
-        $this->config = new Pager();
-        $this->pager  = new \CodeIgniter\Pager\Pager($this->config, Services::renderer());
+        $this->config = new PagerConfig();
+        $this->pager  = new Pager($this->config, Services::renderer());
     }
 
     public function testSetPathRemembersPath()
@@ -180,6 +180,15 @@ public function testStoreWithSegments()
         );
     }
 
+    public function testGetPageURIWithURIReturnObject()
+    {
+        $this->pager->store('bar', 5, 25, 100, 1);
+
+        $uri = $this->pager->getPageURI(7, 'bar', true);
+
+        $this->assertInstanceOf(URI::class, $uri);
+    }
+
     public function testHasMoreDefaultsToFalse()
     {
         $this->assertFalse($this->pager->hasMore('foo'));
@@ -463,8 +472,8 @@ public function testBasedURI()
 
         Services::injectMock('request', $request);
 
-        $this->config = new Pager();
-        $this->pager  = new \CodeIgniter\Pager\Pager($this->config, Services::renderer());
+        $this->config = new PagerConfig();
+        $this->pager  = new Pager($this->config, Services::renderer());
 
         $_GET['page_foo'] = 2;