fix: DefinedRouteCollector.php to use RouteCollectionInterface

[webalchemist]

Use RouteCollectorInterface rather than RouteCollector to allow for people implementing new RouteCollectors by implementing the interface as intended.

Currently this would generate type errors.

Referenced in <#8204>

Checklist:

• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[kenjis]

Don't remove the PR template.

[webalchemist]

Sorry, I'm not really familiar with the process. Just trying to help.

[kenjis]

Okay, thank you for trying to improve CI4.
We use the checklist to check the PR.

Unfortunately, this issue is not easy to fix.
Because RouteCollectionInterface is broken, so if you fix the DefinedRouteCollector,
the following PHPStan errors are reported.

Error: Method CodeIgniter\Router\RouteCollectionInterface::getRoutes() invoked with 1 parameter, 0 required.
Error: Call to an undefined method CodeIgniter\Router\RouteCollectionInterface::getRoutesOptions().
Error: Call to an undefined method CodeIgniter\Router\RouteCollectionInterface::getRoutesOptions().
 ------ ------------------------------------------------------------------ 
  Line   system/Router/DefinedRouteCollector.php                           
 ------ ------------------------------------------------------------------ 
  50     Method CodeIgniter\Router\RouteCollectionInterface::getRoutes()   
         invoked with 1 parameter, 0 required.                             
  55     Call to an undefined method                                       
         CodeIgniter\Router\RouteCollectionInterface::getRoutesOptions().  
  60     Call to an undefined method                                       
         CodeIgniter\Router\RouteCollectionInterface::getRoutesOptions().  
 ------ ------------------------------------------------------------------ 


Error:  [ERROR] Found 3 errors     

https://github.com/codeigniter4/CodeIgniter4/actions/runs/6858472463/job/18649336485?pr=8206

[webalchemist]

It looks like RouteCollectionInterface hasn't been updated along with the changes to RouteCollection either. There are some additional functions and some changes to function parameter lists.
Nothing else within the framework implements RouteCollectionInterface so it should be safe to update.

[kenjis]

If the core team agrees, it would be possible to fix the interface in 4.5 branch.
I personally am in favor of fixing it.

But we do not accept a interface change in develop branch.
See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/workflow.md#if-you-sent-to-the-wrong-branch

[MGatner]

How about adding a new interface in 4.5 instead, then using that for the parameter? Slightly less breakage, and as long as the class implements both interfaces (or maybe the new one extends the old?) it shouldn't affect 99% of devs.

[kenjis]

I sent another PR #8911