Merge branch 'feature/zendframework/zendframework#5518-allow-custom-r…

…ow-count-column-name' into develop

Close zendframework/zendframework#5518

src/Adapter/DbSelect.php

@@ -18,42 +18,57 @@
 
 class DbSelect implements AdapterInterface
 {
+    const ROW_COUNT_COLUMN_NAME = 'C';
 
     /**
      * @var Sql
      */
-    protected $sql = null;
+    protected $sql;
 
     /**
      * Database query
      *
      * @var Select
      */
-    protected $select = null;
+    protected $select;
+
+    /**
+     * Database count query
+     *
+     * @var Select|null
+     */
+    protected $countSelect;
 
     /**
      * @var ResultSet
      */
-    protected $resultSetPrototype = null;
+    protected $resultSetPrototype;
 
     /**
      * Total item count
      *
      * @var int
      */
-    protected $rowCount = null;
+    protected $rowCount;
 
     /**
      * Constructor.
      *
      * @param Select $select The select query
      * @param Adapter|Sql $adapterOrSqlObject DB adapter or Sql object
      * @param null|ResultSetInterface $resultSetPrototype
+     * @param null|Select $countSelect
+     *
      * @throws Exception\InvalidArgumentException
      */
-    public function __construct(Select $select, $adapterOrSqlObject, ResultSetInterface $resultSetPrototype = null)
-    {
+    public function __construct(
+        Select $select,
+        $adapterOrSqlObject,
+        ResultSetInterface $resultSetPrototype = null,
+        Select $countSelect = null
+    ) {
         $this->select = $select;
+        $this->countSelect = $countSelect;
 
         if ($adapterOrSqlObject instanceof Adapter) {
             $adapterOrSqlObject = new Sql($adapterOrSqlObject);
@@ -102,21 +117,38 @@ public function count()
             return $this->rowCount;
         }
 
+        $select = $this->getSelectCount();
+
+        $statement = $this->sql->prepareStatementForSqlObject($select);
+        $result    = $statement->execute();
+        $row       = $result->current();
+
+        $this->rowCount = (int) $row[self::ROW_COUNT_COLUMN_NAME];
+
+        return $this->rowCount;
+    }
+
+    /**
+     * Returns select query for count
+     *
+     * @return Select
+     */
+    protected function getSelectCount()
+    {
+        if ($this->countSelect) {
+            return $this->countSelect;
+        }
+
         $select = clone $this->select;
         $select->reset(Select::LIMIT);
         $select->reset(Select::OFFSET);
         $select->reset(Select::ORDER);
 
         $countSelect = new Select;
-        $countSelect->columns(array('c' => new Expression('COUNT(1)')));
-        $countSelect->from(array('original_select' => $select));
-
-        $statement = $this->sql->prepareStatementForSqlObject($countSelect);
-        $result    = $statement->execute();
-        $row       = $result->current();
 
-        $this->rowCount = $row['c'];
+        $countSelect->columns(array(self::ROW_COUNT_COLUMN_NAME => new Expression('COUNT(1)')));
+        $countSelect->from(array('original_select' => $select));
 
-        return $this->rowCount;
+        return $countSelect;
     }
 }

test/Adapter/DbSelectTest.php

@@ -17,56 +17,53 @@
  */
 class DbSelectTest extends \PHPUnit_Framework_TestCase
 {
-    /** @var \PHPUnit_Framework_MockObject_MockObject */
+    /** @var \PHPUnit_Framework_MockObject_MockObject|\Zend\Db\Sql\Select */
     protected $mockSelect;
 
-    /** @var \PHPUnit_Framework_MockObject_MockObject */
+    /** @var PHPUnit_Framework_MockObject_MockObject|\Zend\Db\Sql\Select */
+    protected $mockSelectCount;
+
+    /** @var \PHPUnit_Framework_MockObject_MockObject|\Zend\Db\Adapter\Driver\StatementInterface */
     protected $mockStatement;
 
-    /** @var \PHPUnit_Framework_MockObject_MockObject */
+    /** @var \PHPUnit_Framework_MockObject_MockObject|\Zend\Db\Adapter\Driver\ResultInterface */
     protected $mockResult;
 
-    /** @var \PHPUnit_Framework_MockObject_MockObject */
+    /** @var \PHPUnit_Framework_MockObject_MockObject|\Zend\Db\Sql\Sql */
     protected $mockSql;
 
     /** @var DbSelect */
     protected $dbSelect;
 
     public function setup()
     {
-        $mockResult = $this->getMock('Zend\Db\Adapter\Driver\ResultInterface');
-        $this->mockResult = $mockResult;
-
-        $mockStatement = $this->getMock('Zend\Db\Adapter\Driver\StatementInterface');
-        $this->mockStatement = $mockStatement;
+        $this->mockResult    = $this->getMock('Zend\Db\Adapter\Driver\ResultInterface');
+        $this->mockStatement = $this->getMock('Zend\Db\Adapter\Driver\StatementInterface');
 
         $this->mockStatement->expects($this->any())->method('execute')->will($this->returnValue($this->mockResult));
 
-        $mockDriver = $this->getMock('Zend\Db\Adapter\Driver\DriverInterface');
-        $mockDriver->expects($this->any())->method('createStatement')->will($this->returnValue($mockStatement));
-
+        $mockDriver   = $this->getMock('Zend\Db\Adapter\Driver\DriverInterface');
         $mockPlatform = $this->getMock('Zend\Db\Adapter\Platform\PlatformInterface');
+
+        $mockDriver->expects($this->any())->method('createStatement')->will($this->returnValue($this->mockStatement));
         $mockPlatform->expects($this->any())->method('getName')->will($this->returnValue('platform'));
-        $mockAdapter = $this->getMockForAbstractClass(
-            'Zend\Db\Adapter\Adapter',
-            array($mockDriver, $mockPlatform)
-        );
 
-        $mockSql = $this->getMock(
+        $this->mockSql = $this->getMock(
             'Zend\Db\Sql\Sql',
             array('prepareStatementForSqlObject', 'execute'),
-            array($mockAdapter)
+            array($this->getMockForAbstractClass('Zend\Db\Adapter\Adapter', array($mockDriver, $mockPlatform)))
         );
-        $this->mockSql = $mockSql;
-        $this->mockSql->expects($this->once())
+
+        $this
+            ->mockSql
+            ->expects($this->once())
             ->method('prepareStatementForSqlObject')
             ->with($this->isInstanceOf('Zend\Db\Sql\Select'))
             ->will($this->returnValue($this->mockStatement));
 
-
-        $this->mockSelect = $this->getMock('Zend\Db\Sql\Select');
-
-        $this->dbSelect = new DbSelect($this->mockSelect, $mockSql);
+        $this->mockSelect      = $this->getMock('Zend\Db\Sql\Select');
+        $this->mockSelectCount = $this->getMock('Zend\Db\Sql\Select');
+        $this->dbSelect        = new DbSelect($this->mockSelect, $this->mockSql);
     }
 
     public function testGetItems()
@@ -79,11 +76,20 @@ public function testGetItems()
 
     public function testCount()
     {
-        $this->mockResult->expects($this->once())->method('current')->will($this->returnValue(array('c' => 5)));
+        $this->mockResult->expects($this->once())->method('current')->will($this->returnValue(array(DbSelect::ROW_COUNT_COLUMN_NAME => 5)));
 
         $this->mockSelect->expects($this->exactly(3))->method('reset'); // called for columns, limit, offset, order
 
         $count = $this->dbSelect->count();
         $this->assertEquals(5, $count);
     }
+
+    public function testCustomCount()
+    {
+        $this->dbSelect = new DbSelect($this->mockSelect, $this->mockSql, null, $this->mockSelectCount);
+        $this->mockResult->expects($this->once())->method('current')->will($this->returnValue(array(DbSelect::ROW_COUNT_COLUMN_NAME => 7)));
+
+        $count = $this->dbSelect->count();
+        $this->assertEquals(7, $count);
+    }
 }

test/Adapter/DbTableGatewayTest.php

@@ -10,8 +10,8 @@
 namespace ZendTest\Paginator\Adapter;
 
 use Zend\Db\Adapter\Platform\Sql92;
+use Zend\Paginator\Adapter\DbSelect;
 use Zend\Paginator\Adapter\DbTableGateway;
-use Zend\Db\ResultSet\ResultSet;
 
 /**
  * @group Zend_Paginator
@@ -74,7 +74,7 @@ public function testCount()
         $mockResult = $this->getMock('Zend\Db\Adapter\Driver\ResultInterface');
         $mockResult->expects($this->any())
                    ->method('current')
-                   ->will($this->returnValue(array('c' => 10)));
+                   ->will($this->returnValue(array(DbSelect::ROW_COUNT_COLUMN_NAME => 10)));
 
         $this->mockStatement->expects($this->any())
              ->method('execute')