Merge pull request #12714 from cakephp/bugfix/pagination-default-mult…

…i-sort Fix paginator defaulting for multi-default-sort.
cakephp · Nov 11, 2018 · d080e1d · d080e1d
2 parents 21c8fce + d252e0b
commit d080e1d
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 4 deletions.
diff --git a/src/Datasource/Paginator.php b/src/Datasource/Paginator.php
@@ -221,7 +221,7 @@ public function paginate($object, array $params = [], array $settings = [])
             'nextPage' => $count > ($page * $limit),
             'pageCount' => $pageCount,
             'sort' => $options['sort'],
-            'direction' => current($order),
+            'direction' => isset($options['sort']) ? current($order) : null,
             'limit' => $defaults['limit'] != $limit ? $limit : null,
             'sortDefault' => $sortDefault,
             'directionDefault' => $directionDefault,

diff --git a/src/View/Helper/PaginatorHelper.php b/src/View/Helper/PaginatorHelper.php
@@ -436,6 +436,7 @@ public function sort($key, $title = null, array $options = [])
 
             $title = __(Inflector::humanize(preg_replace('/_id$/', '', $title)));
         }
+
         $defaultDir = isset($options['direction']) ? strtolower($options['direction']) : 'asc';
         unset($options['direction']);
 

diff --git a/tests/TestCase/Datasource/PaginatorTest.php b/tests/TestCase/Datasource/PaginatorTest.php
@@ -24,7 +24,6 @@
 
 class PaginatorTest extends TestCase
 {
-
     /**
      * fixtures property
      *
@@ -42,6 +41,11 @@ class PaginatorTest extends TestCase
      */
     public $autoFixtures = false;
 
+    /**
+     * @var \Cake\Datasource\Paginator
+     */
+    public $Paginator;
+
     /**
      * setup
      *
@@ -247,6 +251,43 @@ public function testDefaultPaginateParams()
         $this->Paginator->paginate($table, [], $settings);
     }
 
+    /**
+     * Tests that flat default pagination parameters work for multi order.
+     *
+     * @return void
+     */
+    public function testDefaultPaginateParamsMultiOrder()
+    {
+        $settings = [
+            'order' => ['PaginatorPosts.id' => 'DESC', 'PaginatorPosts.title' => 'ASC'],
+        ];
+
+        $table = $this->_getMockPosts(['query']);
+        $query = $this->_getMockFindQuery();
+
+        $table->expects($this->once())
+            ->method('query')
+            ->will($this->returnValue($query));
+
+        $query->expects($this->once())
+            ->method('applyOptions')
+            ->with([
+                'limit' => 20,
+                'page' => 1,
+                'order' => $settings['order'],
+                'whitelist' => ['limit', 'sort', 'page', 'direction'],
+                'scope' => null,
+                'sort' => null,
+            ]);
+
+        $this->Paginator->paginate($table, [], $settings);
+
+        $pagingParams = $this->Paginator->getPagingParams();
+        $this->assertNull($pagingParams['PaginatorPosts']['direction']);
+        $this->assertFalse($pagingParams['PaginatorPosts']['sortDefault']);
+        $this->assertFalse($pagingParams['PaginatorPosts']['directionDefault']);
+    }
+
     /**
      * test that default sort and default direction are injected into request
      *
@@ -878,6 +919,9 @@ public function testValidateSortWhitelistMultiple()
         $this->assertEquals($expected, $result['order']);
     }
 
+    /**
+     * @return \Cake\Datasource\RepositoryInterface|\PHPUnit\Framework\MockObject\MockObject
+     */
     protected function getMockRepository()
     {
         $model = $this->getMockBuilder('Cake\Datasource\RepositoryInterface')
@@ -890,6 +934,9 @@ protected function getMockRepository()
         return $model;
     }
 
+    /**
+     * @return \Cake\Datasource\RepositoryInterface|\PHPUnit\Framework\MockObject\MockObject
+     */
     protected function mockAliasHasFieldModel()
     {
         $model = $this->getMockRepository();
@@ -1335,7 +1382,7 @@ public function testPaginateQueryWithLimit()
      * Helper method for making mocks.
      *
      * @param array $methods
-     * @return \Cake\ORM\Table
+     * @return \Cake\ORM\Table|\PHPUnit\Framework\MockObject\MockObject
      */
     protected function _getMockPosts($methods = [])
     {
@@ -1359,10 +1406,12 @@ protected function _getMockPosts($methods = [])
     /**
      * Helper method for mocking queries.
      *
-     * @return \Cake\ORM\Query
+     * @param string|null $table
+     * @return \Cake\ORM\Query|\PHPUnit\Framework\MockObject\MockObject
      */
     protected function _getMockFindQuery($table = null)
     {
+        /** @var \Cake\ORM\Query|\PHPUnit\Framework\MockObject\MockObject $query */
         $query = $this->getMockBuilder('Cake\ORM\Query')
             ->setMethods(['total', 'all', 'count', 'applyOptions'])
             ->disableOriginalConstructor()