[5.7] Add callable docblock to route registrar methods #26524
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Yesterday I replied on Twitter on an article about tuple/callable route registration that was recently added. However I wasn't completely right that it works. This PR should make it work.
Relevant PR: #24385
Article: https://murze.be/a-better-way-to-register-routes-in-laravel
Tweet: https://twitter.com/patrickbrouwers/status/1062854056522190849
When using Route registration as follows:
(same for typehinted
$router
- as Registrar/Router)You can have the benefit of an IDE (tested with PHPStorm) to rename the
methodName
string automatically whenever you refactor/rename the actual method name.However, PhpStorm only does this when the parameter is docblocked as
callable
. This PR adds thecallable
docblock to the$action
param, so auto-refactoring works in IDE's.Additional suggestion:
Could be an option to drop the
Closure
docblock, as that's captured withcallable
already.