Fixed return type for CriteriaInterface::getLimit

See: #15004

CHANGELOG-4.0.md

@@ -8,6 +8,7 @@
 - Changed the way `Phalcon\Http\Response::__construct` checks `content` data type. Now a `TypeError` will be thrown if incompatible data type was passed [#14983](https://github.com/phalcon/cphalcon/issues/14983)
 - Changed return type hints of the following `Phalcon\Flash\FlashInterface`'s methods: `error`, `message`, `notice`, `success` and `warning` [#14994](https://github.com/phalcon/cphalcon/issues/14994)
 - Changed return type hint for `Phalcon\Mvc\ModelInterface::sum` [#15000](https://github.com/phalcon/cphalcon/issues/15000)
+- Changed return type for `Phalcon\Mvc\Model\Criteria::getLimit` so that integer, NULL or array will be returned [#15004](https://github.com/phalcon/cphalcon/issues/15004)
 
 ## Fixed
 - Fixed `Phalcon\Mvc\Model\Query\Builder::getPhql` to add single quote between string value on a simple condition [#14874](https://github.com/phalcon/cphalcon/issues/14874)
@@ -43,6 +44,7 @@
 - Fixed return type hints of the following `Phalcon\Flash\AbstractFlash`'s methods: `error`, `notice`, `success` and `warning` [#14994](https://github.com/phalcon/cphalcon/issues/14994)
 - Fixed return type hint for `Phalcon\Translate\InterpolatorFactory::newInstance` [#14996](https://github.com/phalcon/cphalcon/issues/14996)
 - Fixed return type hint for `Phalcon\Mvc\Model::sum` [#15000](https://github.com/phalcon/cphalcon/issues/15000)
+- Fixed return type hint for `Phalcon\Mvc\Model\CriteriaInterface::getLimit` and `Phalcon\Mvc\Model\Criteria::getLimit` to follow documentation and original purpose [#15004](https://github.com/phalcon/cphalcon/issues/15004)
 
 [#14987](https://github.com/phalcon/cphalcon/issues/14987)
 

phalcon/Mvc/Model/Criteria.zep

@@ -393,15 +393,15 @@ class Criteria implements CriteriaInterface, InjectionAwareInterface
     }
 
     /**
-     * Returns the limit parameter in the criteria, which will be an integer if
-     * limit was set without an offset, an array with 'number' and 'offset' keys
-     * if an offset was set with the limit, or null if limit has not been set.
+     * Returns the limit parameter in the criteria, which will be
      *
-     * @return string|null
+     * - An integer if 'limit' was set without an 'offset'
+     * - An array with 'number' and 'offset' keys if an offset was set with the limit
+     * - NULL if limit has not been set
      */
-    public function getLimit() -> string | null
+    public function getLimit()  -> int | array | null
     {
-        var limit;
+        var limit, offset;
 
         if !fetch limit, this->params["limit"] {
             return null;
@@ -634,10 +634,14 @@ class Criteria implements CriteriaInterface, InjectionAwareInterface
             return this;
         }
 
-        let this->params["limit"] = [
-            "number": limit,
-            "offset": offset
-        ];
+        if offset == 0 {
+            let this->params["limit"] = limit;
+        } else {
+            let this->params["limit"] = [
+                "number": limit,
+                "offset": offset
+            ];
+        }
 
         return this;
     }

phalcon/Mvc/Model/CriteriaInterface.zep

@@ -4,8 +4,8 @@
  *
  * (c) Phalcon Team <[email protected]>
  *
- * For the full copyright and license information, please view the LICENSE.txt
- * file that was distributed with this source code.
+ * For the full copyright and license information, please view the
+ * LICENSE.txt file that was distributed with this source code.
  */
 
 namespace Phalcon\Mvc\Model;
@@ -98,11 +98,13 @@ interface CriteriaInterface
     public function getHaving();
 
     /**
-     * Returns the limit parameter in the criteria, which will be an integer if
-     * limit was set without an offset, an array with 'number' and 'offset' keys
-     * if an offset was set with the limit, or null if limit has not been set.
+     * Returns the limit parameter in the criteria, which will be
+     *
+     * - An integer if 'limit' was set without an 'offset'
+     * - An array with 'number' and 'offset' keys if an offset was set with the limit
+     * - NULL if limit has not been set
      */
-    public function getLimit() -> string | null;
+    public function getLimit() -> int | array | null;
 
     /**
      * Returns an internal model name on which the criteria will be applied

tests/database/Mvc/Model/Criteria/LimitCest.php

@@ -5,8 +5,8 @@
  *
  * (c) Phalcon Team <[email protected]>
  *
- * For the full copyright and license information, please view the LICENSE.txt
- * file that was distributed with this source code.
+ * For the full copyright and license information, please view the
+ * LICENSE.txt file that was distributed with this source code.
  */
 
 declare(strict_types=1);
@@ -16,24 +16,34 @@
 use DatabaseTester;
 use Phalcon\Mvc\Model\Criteria;
 use Phalcon\Mvc\Model\Query\Builder;
+use Phalcon\Storage\Exception;
 use Phalcon\Test\Fixtures\Traits\DiTrait;
 use Phalcon\Test\Models\Invoices;
 
-/**
- * Class LimitCest
- */
 class LimitCest
 {
     use DiTrait;
 
-    public function _before(DatabaseTester $I)
+    /**
+     * Executed before each test
+     *
+     * @param  DatabaseTester $I
+     * @return void
+     */
+    public function _before(DatabaseTester $I): void
     {
-        $this->setNewFactoryDefault();
+        try {
+            $this->setNewFactoryDefault();
+        } catch (Exception $e) {
+            $I->fail($e->getMessage());
+        }
     }
 
     /**
      * Tests Phalcon\Mvc\Model\Criteria :: limit()
      *
+     * @param  DatabaseTester $I
+     *
      * @author Phalcon Team <[email protected]>
      * @since  2020-02-01
      *
@@ -58,20 +68,16 @@ public function mvcModelCriteriaLimit(DatabaseTester $I)
         $expected = 'SELECT [Phalcon\Test\Models\Invoices].* '
             . 'FROM [Phalcon\Test\Models\Invoices] '
             . 'LIMIT :APL0:';
-        $actual   = $builder->getPhql();
-        $I->assertEquals($expected, $actual);
 
-        $expected = [
-            'number' => 10,
-            'offset' => 0,
-        ];
-        $actual   = $criteria->getLimit();
-        $I->assertEquals($expected, $actual);
+        $I->assertEquals($expected, $builder->getPhql());
+        $I->assertEquals(10, $criteria->getLimit());
     }
 
     /**
      * Tests Phalcon\Mvc\Model\Criteria :: limit() - offset
      *
+     * @param  DatabaseTester $I
+     *
      * @author Phalcon Team <[email protected]>
      * @since  2020-02-01
      *
@@ -96,14 +102,14 @@ public function mvcModelCriteriaLimitOffset(DatabaseTester $I)
         $expected = 'SELECT [Phalcon\Test\Models\Invoices].* '
             . 'FROM [Phalcon\Test\Models\Invoices] '
             . 'LIMIT :APL0: OFFSET :APL1:';
-        $actual   = $builder->getPhql();
-        $I->assertEquals($expected, $actual);
+
+        $I->assertEquals($expected, $builder->getPhql());
 
         $expected = [
             'number' => 10,
             'offset' => 15,
         ];
-        $actual   = $criteria->getLimit();
-        $I->assertEquals($expected, $actual);
+
+        $I->assertEquals($expected, $criteria->getLimit());
     }
 }