lassehaslev/laravel-package-router

lassehaslev/laravel-package-router

Your package routes made REALLY simple!, _(*1)

Install

Run composer require lassehaslev/laravel-package-router, _(*2)

Usage

This is a global/universal object to handle your routes., _(*3)

Even tough this package is made to handle routes in packages, it is no trouble using it wherever you want., _(*4)

Register your routes

Add your routes in ServiceProvider@register, _(*5)

// It is recommended that you extend the class
class MyRouter extends LasseHaslev\LaravelPackageRouter\PackageRouter {}

// Create new router
$router = MyRouter::create();

// Add route to router
$router->add( 'users.index', [
    'uri'=>'users',
    'as'=>'users.index',
    'uses'=>'Controller@index',
] )
// You can also chain add
->app( 'users.update', [
    'uri'=>'users/{user}',
    'method'=>'put',
    'uses'=>'Controller@index',
] );

->add( 'images.index', [
    'uri'=>'images',
    'uses'=>'Controller@index',
] )
->add( 'images.store', [
    'uri'=>'images',
    'method'=>'post',
    'uses'=>'Controller@store',
] )

Register routes

Note that you can get the reference of the router only by calling MyRouter::get() even though you created it another place. This is because it extends LasseHaslev\UniversalObjects\Object., _(*6)

// Usually in your routes/web.php
$myRouter = MyRouter::get();

$myRouter->route( 'images.index' ); // "/images"
Route::group([ 'prefix'=>'backend', 'middleware'=>'auth' ], function( $router ) use ( $myRouter ) {
    $myRouter->routes( 'users' ); // "/backend/users" and "/backend/users/{user}"
    $myRouter->route( 'images.store' ); // "/backend/images"
});

Api

// Get the router
$router = MyRouter::create(); // MyRouter::get();

// Add route
$router->add( $reference, [
    'uri'=>'users',
    'method'=>'get',
    'as'=>'users.index',
    'uses'=>'Controller@index',
    // 'middleware'=>'auth', // You can add middleware if you want to
] );

// Get all routes
$router->routes(); // Set routes for users.index, images.index and images.show

// Get all routes under images namespace
$router->routes( 'images' ); // Set routes for images.index and images.show

// Get single route
$router->route( 'images.index' );

Development

``` bash, <sub>(*7)</sub>

Install dependencies

composer install, <sub>(*8)</sub>

Install dependencies for automatic tests

yarn, <sub>(*9)</sub>

Run one time

npm run test, <sub>(*10)</sub>

Automaticly run test on changes

npm run dev ```, <sub>(*11)</sub>