Download the PHP package ricventu/laravel-route-maze without Composer
On this page you can find all versions of the php package ricventu/laravel-route-maze. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ricventu/laravel-route-maze
More information about ricventu/laravel-route-maze
Files in ricventu/laravel-route-maze
Package laravel-route-maze
Short Description A quick and easy way to create the routes is to take advantage of the convention over configuration
License MIT
Homepage https://github.com/ricventu/laravel-route-maze
Informations about the package laravel-route-maze
Convention over configuration Laravel route generator
A quick and easy way to auto generate routes, is to take advantage of the convention over configuration and PHP attributes.
This means that routes are automatically generated based on the directory structure of the controllers and the methods attributes.
In this way, you don't have to manually write the routes in the web.php or api.php file, but just follow some rules of file naming and organization.
Route groups are base on subdirectories of the controllers.
Let's see how to do it with a practical example.
Controller: App/Http/Controllers/SomeCategory/ProductsController.php
To get routes simpli add the the following line to routes/web.php
The generated routes are:
Parameters in path
Parameters can be specified in the path naming the directory with _param-name_
.
Http/Controllers/_param1_/ItemsController.php
becomes
Middleware
You can specify middleware group by adding a file named middleware.php
in the controller directory.
Naming conventions
Uri and route name are composed of directories name, first part of the controller name (before Controller
) and method name, all in kebab-case.
examples:
Controller name | Method name | Route name | Route path |
---|---|---|---|
SomeProductController | showItem($id) | some.product.show-item | /some-product/show-item/{id} |
SomeProductController | storeItem | some.product.store-item | /some-product/store-item |
SomeProductController | updateItem($id) | some.product.update-item | /some-product/update-item/{id} |
SomeProductController | destroyItem($id) | some.product.destroy-item | /some-product/destroy-item/{id} |
Disable discover for a Controller
To disable route discover for a specified crontroller, add static method mazeDisabled
that returns true
In path configuration
If in the path is present a file named maze.php
, it will be used to configure the route group.
Key | Description | Default |
---|---|---|
ignore_path_name | Ignore path and name in route | false |
disabled | Disable discovering of the entire path |
bash composer require ricventu/laravel-route-maze bash composer test
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Performance note
In production deployment, it's recommended to cache route discovering using Laravel `route:cache` built in command
## Credits
- [Riccardo Venturini](https://github.com/ricventu)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
All versions of laravel-route-maze with dependencies
spatie/laravel-package-tools Version ^1.14.0
illuminate/contracts Version ^10.0