grummfy / laravel-route-controller
Define Router::controller() without breaking everything
Installs: 3 472
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- illuminate/routing: ^5.5
This package is auto-updated.
Last update: 2024-10-28 18:55:38 UTC
README
This library like other existing, give a way to deal with Router::controller
.
The key features:
- allow caching of route
- doesn't require extra manipulation
- allow inheritance of route group
- namespace independent
Compatible with laravel 5.5. (probably compatible with older version too).
Install
Install the dependencies
composer require grummfy/laravel-route-controller
Publish the configuration
php artisan vendor:publish --tag=config --provider=Grummfy\LaravelRouteController\RouteControllerProvider
Usage
Once the package is install and autodiscover (or you have added the provider manually), the package is ready to use.
In your route file, just do this:
Route::controller('/foo', \App\Http\Controllers\FooController::class);
It will take all the public method from the class (including traits) and convert it to route.
There is a third argument that you can use to add extra option, like a middleware or anything else.
Route::controller('/foo', \App\Http\Controllers\FooController::class, ['middleware' => 'can:baz']);
You got also an extra option, to don't allow heritance of methods from parent:
Route::controller('/foo', \App\Http\Controllers\FooController::class, ['middleware' => 'can:baz', 'heritage' => false]);
Example
Imagine that we have the class FooController (see example), in this case we will have a series of method that will be converted to routes:
- index() -> /foo, foo.index
- getStatus(string $status) -> /foo/status/{status}, foo.status.post
- postStatus(string $status) -> /foo/status/{status}, foo.status.get
- foo() -> /foo/foo, foo.foo
- my() -> /foo/my, foo.my
TODO
- unit test
- QA tools
- travis
- styleci
- scrutinizer
- ...