[BUG]: Incorrect return type hint of Phalcon\Mvc\Model\CriteriaInterface::getLimit()

[sergeyklay]

The documentation says:

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.

But actual return type hint declared as string | null (not int | array | null):

cphalcon/phalcon/Mvc/Model/Criteria.zep

Lines 395 to 411 in d3e9463

	/**
	* 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.
	*
	* @return string|null
	*/
	public function getLimit() -> string | null
	{
	var limit;
	if !fetch limit, this->params["limit"] {
	return null;
	}
	return limit;
	}

This leads to a fatal error:

<?php

use Phalcon\Di;
use Phalcon\Di\FactoryDefault;
use Phalcon\Db\Adapter\PdoFactory;
use Phalcon\Mvc\Model;
use Phalcon\Mvc\Model\Criteria;

$options = ['dbname' => '/tmp/test.sqlite'];

Di::reset();

$container = new FactoryDefault();
Di::setDefault($container);

$container->setShared(
    'db',
    (new PdoFactory())->newInstance('sqlite', $options)
);

class Invoices extends Model {
    public $inv_id;
    public $inv_cst_id;
    public $inv_status_flag;
    public $inv_title;
    public $inv_total;
    public $inv_created_at;

    public function initialize()
    {
        $this->setSource('co_invoices');
    }
}

$criteria = new Criteria();
$criteria->setDI($container);
$criteria
    ->setModelName(Invoices::class)
    ->limit(10, 15)
;

var_dump($criteria->getLimit());

PHP Fatal error:
Return value of Phalcon\Mvc\Model\Criteria::getLimit()
must be of the type string or null, array returned

[sergeyklay]

Fixed in 4.0.x branch