Allow setting custom paginator.

cakephp · Jun 5, 2017 · a629580 · a629580
1 parent 40d86e7
commit a629580
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 3 deletions.
diff --git a/src/Controller/Component/PaginatorComponent.php b/src/Controller/Component/PaginatorComponent.php
@@ -66,7 +66,12 @@ class PaginatorComponent extends Component
      */
     public function __construct(ComponentRegistry $registry, array $config = [])
     {
-        $this->_paginator = new Paginator();
+        if (isset($config['paginator'])) {
+            $this->_paginator = $config['paginator'];
+            unset($config['paginator']);
+        } else {
+            $this->_paginator = new Paginator();
+        }
 
         parent::__construct($registry, $config);
     }
@@ -224,6 +229,29 @@ public function mergeOptions($alias, $settings)
         return $this->_paginator->mergeOptions($alias, $settings);
     }
 
+    /**
+     * Set paginator instance.
+     *
+     * @param \Cake\ORM\Paginator $paginator Paginator instance.
+     * @return self
+     */
+    public function setPaginator(Paginator $paginator)
+    {
+        $this->_paginator = $paginator;
+
+        return $this;
+    }
+
+    /**
+     * Get paginator instance.
+     *
+     * @return \Cake\ORM\Paginator
+     */
+    public function getPaginator()
+    {
+        return $this->_paginator;
+    }
+
     /**
      * Set paging params to request instance.
      *

diff --git a/tests/TestCase/Controller/Component/PaginatorComponentTest.php b/tests/TestCase/Controller/Component/PaginatorComponentTest.php
@@ -22,6 +22,7 @@
 use Cake\Http\ServerRequest;
 use Cake\Network\Exception\NotFoundException;
 use Cake\ORM\Entity;
+use Cake\ORM\Paginator;
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 
@@ -39,6 +40,13 @@ class PaginatorTestController extends Controller
     public $components = ['Paginator'];
 }
 
+/**
+ * Custom paginator
+ */
+class CustomPaginator extends Paginator
+{
+}
+
 class PaginatorComponentTest extends TestCase
 {
 
@@ -70,8 +78,8 @@ public function setUp()
         $this->request = new ServerRequest('controller_posts/index');
         $this->request->params['pass'] = [];
         $controller = new Controller($this->request);
-        $registry = new ComponentRegistry($controller);
-        $this->Paginator = new PaginatorComponent($registry, []);
+        $this->registry = new ComponentRegistry($controller);
+        $this->Paginator = new PaginatorComponent($this->registry, []);
 
         $this->Post = $this->getMockBuilder('Cake\Datasource\RepositoryInterface')
             ->disableOriginalConstructor()
@@ -89,6 +97,27 @@ public function tearDown()
         TableRegistry::clear();
     }
 
+    /**
+     * testPaginatorSetting
+     *
+     * @return void
+     */
+    public function testPaginatorSetting()
+    {
+        $paginator = new CustomPaginator();
+        $component = new PaginatorComponent($this->registry, [
+            'paginator' => $paginator
+        ]);
+
+        $this->assertSame($paginator, $component->getPaginator());
+
+        $component = new PaginatorComponent($this->registry, []);
+        $this->assertNotSame($paginator, $component->getPaginator());
+
+        $component->setPaginator($paginator);
+        $this->assertSame($paginator, $component->getPaginator());
+    }
+
     /**
      * Test that non-numeric values are rejected for page, and limit
      *