dragon-code/laravel-route-names

Automatic generation of route names

1.5.0 2024-03-13 07:58 UTC

This package is auto-updated.

Last update: 2024-07-03 10:42:32 UTC


README

Auto Route Names for Laravel

the dragon code route names

Stable Version Unstable Version Total Downloads Github Workflow Status License

Installation

To get the latest version of Laravel Route Names, simply require the project using Composer:

composer require dragon-code/laravel-route-names

Next, replace Illuminate\Foundation\Application with DragonCode\LaravelRouteNames\Application in the bootstrap/app.php file.

You can now list the routes, for example by calling the php artisan route:list command or by using the dragon-code/pretty-routes package.

Using

This is all. Now you don't have to specify route names. Now the route names will be generated automatically based on the final URL of your project.

All previously specified route names in the application will be ignored.

Compatible with all package solutions for expanding the list of routes.

Also, Laravel Idea support coming soon.

Since route names are generated at the time they are received, we recommend using route caching in production:

php artisan route:cache

// or

php artisan optimize

Base Routes

app('router')->get('/', [IndexController::class, 'index']);
app('router')->post('/', [IndexController::class, 'store']);
app('router')->put('/', [IndexController::class, 'update']);
app('router')->delete('/', [IndexController::class, 'delete']);
app('router')->patch('/', [IndexController::class, 'patch']);
app('router')->options('/', [IndexController::class, 'options']);

app('router')->get('pages', [PagesController::class, 'index']);
app('router')->post('pages', [PagesController::class, 'store']);
app('router')->put('pages/{page}', [PagesController::class, 'update']);
app('router')->delete('pages/{page}', [PagesController::class, 'delete']);
app('router')->patch('pages/{page}', [PagesController::class, 'patch']);
app('router')->options('pages/{page}', [PagesController::class, 'options']);
Method Url Name Helper
GET, HEAD / index route('index')
POST / store route('store')
PUT / update route('update')
DELETE / destroy route('destroy')
PATCH / patch route('patch')
OPTIONS / options route('options')
GET, HEAD /pages pages.index route('pages.index')
POST /pages pages.store route('pages.store')
PUT /pages/123 pages.update route('pages.update')
DELETE /pages/123 pages.destroy route('pages.destroy')
PATCH /pages/123 pages.patch route('pages.patch')
OPTIONS /pages/123 pages.options route('pages.options')

Resource Routes

app('router')->resource('authors/{author}/photos', Author\PhotoController::class);
Method Url Name Helper
GET, HEAD /authors/123/photos authors.photos.index route('authors.photos.index')
GET, HEAD /authors/123/photos/create authors.photos.create route('authors.photos.create')
POST /authors/123/photos authors.photos.store route('authors.photos.store')
GET /authors/123/photos/{photo} authors.photos.show route('authors.photos.show')
GET /authors/123/photos/{photo}/edit authors.photos.edit route('authors.photos.edit')
PUT /authors/123/photos/{photo} authors.photos.update route('authors.photos.update')
PATCH /authors/123/photos/{photo} authors.photos.patch route('authors.photos.patch')
DELETE /authors/123/photos/{photo} authors.photos.destroy route('authors.photos.destroy')

API Resource Routes

app('router')->apiResource('authors/{author}/photos', Author\PhotoController::class);
Method Url Name Helper
GET, HEAD /authors/123/photos authors.photos.index route('authors.photos.index')
POST /authors/123/photos authors.photos.store route('authors.photos.store')
GET /authors/123/photos/{photo} authors.photos.show route('authors.photos.show')
PUT /authors/123/photos/{photo} authors.photos.update route('authors.photos.update')
PATCH /authors/123/photos/{photo} authors.photos.patch route('authors.photos.patch')
DELETE /authors/123/photos/{photo} authors.photos.destroy route('authors.photos.destroy')

List of exclusions

By publishing a configuration file with the artisan command, you can explicitly specify a mask of route names that do not need to be translated:

php artisan vendor:publish --provider="DragonCode\LaravelRouteNames\ServiceProvider"

Exceptions

app('router')
    ->get('pages', [IndexController::class, 'index'])
    ->name('my_pages');

return route('my_pages');
//  \Symfony\Component\Routing\Exception\RouteNotFoundException
//  Route [my_pages] not defined.

return route('pages.index');
// Returns the result of executing the `IndexController@index` method.

Result

app('router')
    ->name('pages.')
    ->prefix('pages')
    ->group(function () {
        app('router')->get('/', [Controller::class, 'index']);
        app('router')->post('/', [Controller::class, 'store']);
        app('router')->get('{page}', [Controller::class, 'show']);
        app('router')->delete('{page}', [Controller::class, 'destroy']);
    });

Before:

GET     /pages         pages.
POST    /pages         pages.
GET     /pages/{page}  pages.
DELETE  /pages/{page}  pages.

After:

GET     /pages         pages.index
POST    /pages         pages.store
GET     /pages/{page}  pages.show
DELETE  /pages/{page}  pages.destroy

License

This package is licensed under the MIT License.