Allow RouteRegistrar to be Macroable #56921
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can you provide a use case? |
|
@basantashubhu sure. for example: Before RouteRegistrar being MacroableRoute::prefix('my-prefix')
->name('my-prefix.')
->withoutMiddleware(['throttle:api'])
->middleware(['throttle:my-dedicated-rate-limiter-key'])
->group(function () {
Route::get('my-route', MyController::class);
// ...
});After RouteRegistrar being Macroable will be able to do things like:Route::prefixAndName('my-prefix')
->replaceThrottle('my-dedicated-rate-limiter-key')
->group(function () {
Route::get('my-route', MyController::class);
// ...
});The macro would do things like: Illuminate\Support\Facades\Route::macro('prefixAndName', function (string $key) {
return $this->prefix($key)->name($key . '.');
});
Illuminate\Routing\RouteRegistrar::macro('prefixAndName', function (string $key) {
return $this->prefix($key)->name($key . '.');
});
Illuminate\Routing\Route::macro('prefixAndName', function (string $key) {
return $this->prefix($key)->name($key . '.');
});
// and similar idea for replaceThrottle |
Looks like there should be a mechanism to put macros on multiple classes at the same time 🤔 |
Something like this <?php
namespace App\Support;
class MacroRegistrar
{
public static function register(string $methodName, callable $callback, array $targets)
{
foreach ($targets as $target) {
if (method_exists($target, 'macro')) {
$target::macro($methodName, $callback);
}
}
}
}
...
use App\Support\MacroRegistrar;
MacroRegistrar::register('prefixAndName', function (string $key) {
return $this->prefix($key)->name($key . '.');
}, [
\Illuminate\Support\Facades\Route::class,
\Illuminate\Routing\RouteRegistrar::class,
\Illuminate\Routing\Route::class,
]); |
|
@ghabriel25 My thoughts exactly! 😍👍🏻 This could even be turned into a helper called |
|
Other approach would be to let the facade define its "macro targets": abstract class Facade
{
// …
/**
* Get the macro targets.
*
* @return class-string[]
*
* @throws \RuntimeException
*/
protected static function getMacroTargets(): array
{
throw new RuntimeException('Facade does not implement getFacadeAccessor method.');
}
/**
* @param class-string|class-string[]|null $macro
*/
public static function macro(string $name, object|callable $macro, string|array|null $target = null)
{
$target ??= static::getMacroTargets();
$targets = Arr::wrap($target);
foreach ($targets as $target) {
if (! class_exists($target) || ! in_array(Macroable::class, trait_uses_recursive($target))) {
continue;
}
$target::macro($name, $macro);
}
}
// …
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the
Router(orRoutefacade) and theRouteareMacroable. But sometimes, some methods on theRouterwill give the intermediateRouteRegistrarclass. That class is currently notMacroableand as such, macros can't be added across the breadth of route setup. This PR addsMacroabletoRouteRegistrarso that macros can now be added and used no matter where the developer is in the route registration.