README

This Laravel package allows you to define custom paths for create and edit routes in resource controllers. It extends the functionality of Laravel's resource routing by providing macros to set these paths globally or for specific resources.

Features

Set global custom paths for create and edit actions across all resource routes. Customize paths individually for each resource route. Works seamlessly with both Route::resource() and Route::resources() methods.

Installation

You can install the package via composer:

composer require amdadulhaq/route-resource-paths-laravel

Once installed, the service provider will be registered automatically by Laravel.

Configuration

No additional configuration is required. The package uses Laravel's built-in service container to bind and replace the default resource registrar.

Usage

Setting Global Paths

To set custom paths for the create and edit actions that will apply globally to all resource routes, use the Route::resourcePaths() method:

Route::resourcePaths([
    'create' => 'add',
    'edit' => 'change',
]);

After setting these global paths, all resource routes defined using Route::resource() will use these custom paths instead of the default ones.

Using Global Paths with Route::resource()

The global paths will automatically be applied to all resource controllers like this:

Route::resource('posts', PostController::class);

This will generate routes such as:

GET /posts/add instead of GET /posts/create

GET /posts/{post}/change instead of GET /posts/{post}/edit

Using Global Paths with Route::resources()

You can also use the global paths when registering multiple resource controllers at once:

Route::resources([
    'photos' => PhotoController::class,
    'posts' => PostController::class,
])->paths([
    'create' => 'add',
    'edit' => 'change',
]);

This will apply the same custom paths to both photos and posts resource routes.

Setting Custom Paths for Specific Resources

If you want to set custom paths for a specific resource, you can do so directly when defining the resource:

Route::resource('users', UserController::class)->paths([
    'create' => 'add',
    'edit' => 'change',
]);

This will only affect the routes for the users resource:

GET /users/add instead of GET /users/create GET /users/{user}/change instead of GET /users/{user}/edit

For Resource

use App\Http\Controllers\UserController;

Route::resource('users', UserController::class)->paths([
    'create' => 'add',
    'edit' => 'change',
]);

Usage Example for Singleton Paths

To use the new Route::singletonPaths() method for setting global singleton paths, you can do the following:

Route::singletonPaths([
    'create' => 'setup',
    'edit' => 'modify',
]);

Route::singleton('profile', ProfileController::class)->creatable()->paths([
    'create' => 'setup',
    'edit' => 'modify',
]);

This will generate the following routes for the ProfileController singleton resource:

GET /profile/setup instead of GET /profile/create

GET /profile/modify instead of GET /profile/edit

Credits

License

The MIT License (MIT). Please see License File for more information.

Contributing

If you find any issues or have suggestions for improvements, feel free to create a pull request or open an issue on the GitHub repository.

amdadulhaq / route-resource-paths-laravel

Maintainers

Details