Route::getName() return type

[jarnstedt]

Hi!
The \Phalcon\Mvc\Router\Route::getName() return type string seems to be incorrect.

$route = new \Phalcon\Mvc\Router\Route('example');
var_dump(\Phalcon\Version::get());
var_dump($route->getName());

outputs

string(5) "4.1.2"
NULL

https://github.com/phalcon/ide-stubs/blob/v4.1.0/src/Phalcon/Mvc/Router/Route.php#L202

[niden]

That is correct. You have not set the name of the route. The first parameter in the constructor is the pattern not the name

$route = new \Phalcon\Mvc\Router\Route('example');

var_dump($route->getName()); // null

$route->setName('my-route');
var_dump($route->getName()); // my-route

[dcolt]

@niden The feature might work as expected, but according to the stub file the return value can never be null.
It's not an actual issue in the implementation, just with the stub file giving an incorrect expectation of what values can be returned.
I.e using tools like PHPStan reads the stubs and will be giving incorrect results due to an invalid typehint.
Also take this code as an example:

$route = new \Phalcon\Mvc\Router\Route('example');

function doStuff(string $name) {
    echo $name;
}

doStuff($route->getName()); // Fatal error: Uncaught TypeError: Argument 1 passed to doStuff() must be of the type string, null given

$route->setName('my-route');
doStuff($route->getName()); // my-route

[niden]

@dcolt Ack sorry. I misunderstood. That is indeed a bug we need to address.

[niden]

Transferring this to the main repo for fixing

[niden]

Resolved in #15881

Thank you @jarnstedt and @dcolt