sebastiaanluca/laravel-router

An organized approach to handling Laravel routes.

Laravel Router

![Total downloads][downloads-badge] , _(*1)

![Follow @sebastiaanluca on Twitter][twitter-profile-badge] [][link-twitter-share], _(*2)

An organized approach to handling routes in Laravel., _(*3)

This package provides you with an easy-to-use system to separate route logic into routers based on functionality while also providing additional functionality. A replacement for those bulky web.php and api.php route files that are often lacking any structure and break Laravel structure conventions of separating everything in classes instead of regular PHP files., _(*4)

Do note that it changes nothing to the way you define your routes. It's just a way of organizing them. Optionally you can use the additional functionality it provides, but that's not a requirement., _(*5)

Table of contents

• Requirements
• How to install
  • Further optional setup
• How to use
  • Creating a router
  • Registering the router
    • Manually registering the router
• Optional features
  • Common route parameter patterns
  • Full-domain routing
• License
• Change log
• Testing
• Contributing
• Security
• Credits
• About

Requirements

• PHP 7.3 or higher
• Laravel 7.0 or higher

Looking for support for earlier versions? Try out any of the previous package versions., _(*6)

How to install

Just add the package to your project using Composer and Laravel will auto-discover it:, _(*7)

composer require sebastiaanluca/laravel-router

Further optional setup

If you want to be able to register your routers in a single place, add the RegistersRouters trait to your HTTP kernel (found at App\Http\Kernel):, _(*8)

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;
use SebastiaanLuca\Router\Kernel\RegistersRouters;

class Kernel extends HttpKernel
{
    use RegistersRouters;
}

How to use

Creating a router

The following is an example of a router. It can be placed anywhere you like, though I'd suggest grouping them in the App\Http\Routers directory., _(*9)

<?php

namespace App\Http\Routers;

use SebastiaanLuca\Router\Routers\Router;

class UserRouter extends Router
{
    /**
     * Map the routes.
     */
    public function map()
    {
        $this->router->group(['middleware' => ['web', 'guest']], function () {

            $this->router->get('/users', function () {

                return view('users.index');

            });

        });
    }
}

The map method is where you should define your routes and is the only requirement when using a router. The Laravel routing instance is automatically resolved from the IoC container, so you can use any standard routing functionality you want. Of course you can also use the Route facade., _(*10)

Registering the router

To automatically have the framework load your router and map its routes, add the trait and add the router to the $routers array in your application's HTTP kernel class:, _(*11)

/**
 * The application routers to automatically boot.
 *
 * @var array
 */
protected $routers = [
    \App\Http\Routers\UserRouter::class,
];

Manually registering the router

If you don't want to or can't add the trait to the kernel, you can also register the router manually by just instantiating it (in a service provider for instance). The parent base router will automatically resolve all dependencies and call the map method on your router., _(*12)

app(\App\Http\Routers\UserRouter::class);

Especially useful in packages!, _(*13)

Optional features

To use the following optional features, register the RegisterRoutePatterns class:, _(*14)

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;
use SebastiaanLuca\Router\Kernel\RegistersRouters;

class Kernel extends HttpKernel
{
    use RegistersRouters;

    /**
     * The application routers to automatically boot.
     *
     * @var array
     */
    protected $routers = [
        \SebastiaanLuca\Router\Routers\RegisterRoutePatterns::class,
    ];
}

Common route parameter patterns

Laravel provides a convenient way to validate URL parameters using patterns in routes. This package provides a predefined set of such patterns so you don't have to repeatedly add them to each route or define them yourself. The following parameter patterns are currently included:, _(*15)

• id (\d+)
• hash ([a-z0-9]+)
• uuid ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})
• slug ([a-z0-9-]+)
• token ([a-zA-Z0-9]{64})

So forget about writing:, _(*16)

Route::get('user/activations/{uuid}', function ($uuid) {
    return view('users.activations.show');
})->where('uuid', '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}');

Just use the {uuid} or any other pattern in your route:, _(*17)

$this->router->get('user/activations/{uuid}', function ($uuid) {
    return view('users.activations.show');
});

Full-domain routing

Another great feature of Laravel is sub-domain routing which allows you to handle multiple subdomains within a single Laravel project. The only caveat there is that it only does that and doesn't handle full domains., _(*18)

Laravel Router fixes that for you so you can direct multiple domains to a single Laravel project and handle them all at once. Simply define a route group with the {domain} pattern and use it in your callback or controller:, _(*19)

$this->router->group(['domain' => '{domain}'], function () {

    $this->router->get('user/{id}', function ($domain, $id) {
        return 'You\'re visiting from ' . $domain;
    });

});

License

This package operates under the MIT License (MIT). Please see LICENSE for more information., _(*20)

Change log

Please see CHANGELOG for more information what has changed recently., _(*21)

Testing

bash composer install composer test, _(*22)

Contributing

Please see CONTRIBUTING and CONDUCT for details., _(*23)

Security

If you discover any security related issues, please email hello@sebastiaanluca.com instead of using the issue tracker., _(*24)

Credits

• Sebastiaan Luca
• All Contributors

About

My name is Sebastiaan and I'm a freelance Laravel developer specializing in building custom Laravel applications. Check out my portfolio for more information, my blog for the latest tips and tricks, and my other packages to kick-start your next project., _(*25)

Have a project that could use some guidance? Send me an e-mail at hello@sebastiaanluca.com!, _(*26)