Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olliecodes/laravel-route-registrars
A Laravel package that introduces a clean object based alternative to Laravel route files.
https://github.com/olliecodes/laravel-route-registrars
laravel laravel-framework php routes routing
Last synced: 1 day ago
JSON representation
A Laravel package that introduces a clean object based alternative to Laravel route files.
- Host: GitHub
- URL: https://github.com/olliecodes/laravel-route-registrars
- Owner: olliecodes
- License: mit
- Created: 2022-08-07T15:39:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-16T14:07:05.000Z (over 1 year ago)
- Last Synced: 2024-12-15T12:08:15.700Z (about 1 month ago)
- Topics: laravel, laravel-framework, php, routes, routing
- Language: PHP
- Homepage:
- Size: 916 KB
- Stars: 23
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/olliecodes/laravel-route-registrars)
## 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](https://laravel-news.com/route-registrars), written by [@juststeveking](https://twitter.com/JustSteveKing).
## Install
Install via composer.
```bash
$ 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.
```bash
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`.
```bash
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)
```