feat: can add route handler as callable

[kenjis]

Description

• You can jump to the controller method with IDE.

E.g.:

$routes->get('home', [Hello::class, 'index']);
$routes->get('product/(:num)/(:num)', [[Hello::class, 'index'], '$1/$2']);

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

[mostafakhudair]

Please include additions in the user guide

[iRedds]

[[Home::class, 'index'], '$1/$2'] doesn't look nice

What about?

//[Home::class, 'index', '$1/$2'] 

[$class, $method, $params] = $to; 
is_callable([$class, $method], true, $callableName)

//... 

[kenjis]

[Home::class, 'index', '$1/$2'] seems to be nice.
But we cannot jump to Home::index() source code when we click 'index'

[iRedds]

Yes, you are right.

[paulbalandan]

This needs writeup in the docs.

[iRedds]

In theory. Can we drop $1/$2?

[kenjis]

I will write the docs later.

[kenjis]

Added User Guide.

[iRedds]

@kenjis can you reply to the comment above?
I want to clarify. I meant that $1/$2 is useless in my opinion.

$routes->get('product/(:num)/(:num)', [Hello::class, 'index']);

Here we already have two arguments (:num)/(:num). Which can be passed to a controller method without the $1/$2 notation.
The same principle as the closure works.

$routes->get('product/(:num)/(:num)', fn ($param1, $param2) => 'do something');

i.e. we don't specify $1/$2 and parameters are passed as is.

[lonnieezell]

This looks like a great addition. I would be in favor of removing the $1/$2 params as being specifically needed. While I've had times in the past where I needed to reorder or leave out some parameters, it's never been a big enough deal that it couldn't be worked around, and would clean this up a bit. Maybe make it optional? If it's not provided it defaults to the order given?

[iRedds]

To skip the parameter, the developer can use non-capturing grouping.
For example, for the url product/1/2 and the route product/(?::num)/(:num), the parameter will only be 2.

[kenjis]

@iRedds @lonnieezell how about this?

[iRedds]

It will not work correctly with a non-capturing group.
For product/(?::num)/(:num) the replacement string will be controller::method/$1/$2 and we get the string controller::method/1/ which gives parameter [1, ''].
Perhaps with nested groups there will be a similar situation.

It seems to me that if you use your approach, then you need to trim the slash in Router::checkRoutes().
Or you can add parameters directly to Router::checkRoutes()

} elseif (strpos($val, '$') === false && count($matches) > 1) {
    array_shift($matches);
    $val.= '/' . implode('/', $matches);
}

$this->setRequest(explode('/', $val));

This solution will also allow parameters to be applied to more than just the $to array.
For example, $routes->get('x/(:num)', 'Home::index');
But this is a quick example and I could miss the nuances.

[kenjis]

I think regex is originally complex, and we do not need to support all the pattern.

• do not support non-capturing groups
• do not support nested groups

Or I don't mind to change the implementation if there is simple better one.

But if $routes->get('x/(:num)', 'Home::index'); will add params automatically,
it is a breaking change. So it needs to be considered more.

[kenjis]

Updated the documentation: https://github.com/codeigniter4/CodeIgniter4/pull/5713/files#diff-2a34c841c28af79b5550af42e3e5c24b337fa9ce9e90f8164000ac6c7d5ea7fe

[lonnieezell]

Looks great. Thanks!

[kenjis]

@paulbalandan The commit you approved failed tests.
Fixed.