olliecodes/laravel-route-registrars

Adds route registrars as an alternative object based approach to registering routes.

1.0.0 2022-08-08 15:11 UTC

Requires

• php: ^8.0
• laravel/framework: ^9.0

Requires (Dev)

• marcocesarato/php-conventional-changelog: ^1.10

MIT

• Ollie Read

README

Laravel Route Registrars

This package introduces a clean object based way to define your routes in a Laravel application. A tutorial on the basic premise exists on Laravel news, written by @juststeveking.

Install

Install via composer.

$ composer require olliecodes/laravel-route-registrars

Fresh Laravel Installation

If you're installing this package on a fresh laravel installation, you'll want to run the following command before you do anything with your routes.

php artisan init:routing

This will overwrite the app/Providers/RouteServiceProvider.php file with one compatible with the route registrars, and create default route registrars to replace both routes/web.php and routes/api.php.

Existing Laravel Installation

If you have an existing application, it is recommended that you read through the Laravel News article that covers this approach, as you're going to have to manually refactor your route service provider and route files.

Requirements

This package requires the following;

• PHP >= 8.0 (Including 8).
• laravel/framework >= 9.0

Usage

To register new routes, you can either add their definitions to the map method of a RouteRegistrar, or create a new one.

Creating a new registrar

The following command will create a new registrar inside app/Http/Routes.

php artisan make:registrar {name}

The {name} can be any valid class name, or sub-namespace. For example, using Auth\\GuestRoutes will create app/Http/Routes/Auth/GuestRoutes.php.

There are several options available when creating a registrar.

--C|hasChildren

Create a route registrar that has the MapRouteRegistrars trait so that it can map child registrars.

--W|web

Create the route registrar in app/Http/Routes/Web, an option left in for those of you that are splitting the Web and API routes.

--A|API

Exactly the same as the above option, except it creates it in app/Http/Routes/Api,

Registering Registrars

Any class that wants to register registrars can use the following trait.

OllieCodes\Registrars\Concerns\MapsRouteRegistrars

Once doing so, there are three ways to register. All of them require an instance of the following class.

Illuminate\Contracts\Routing\Registrar

This interface is implemented by the Laravel Router class, so you can use that.

Register multiple

Call the following method with an instance of the laravel router, and an array of fully qualified class names for the registrars.

mapRouteRegistrars(Registrar $router, array $registrars)

Register one

Call the following method with an instance of the laravel router, and the fully qualified class name of the registrars.

mapRouteRegistrar(Registrar $router, string $registrar)

Register from paths

Call the following method with an instance of the laravel router, and an array of paths where the registrars are held.

This method will use the order that the files are returned, so please keep route order precedence in mind.

loadRouteRegistrars(Registrar $router, array $paths)