Download the PHP package proai/lumen-annotations without Composer
On this page you can find all versions of the php package proai/lumen-annotations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download proai/lumen-annotations
More information about proai/lumen-annotations
Files in proai/lumen-annotations
Package lumen-annotations
Short Description Route and event binding annotations for Laravel Lumen
License MIT
Homepage http://github.com/proai/lumen-annotations
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package lumen-annotations
Lumen Annotations
This package enables annotations in Laravel Lumen to define routes and event bindings.
Installation
Lumen Annotations is distributed as a composer package. So you first have to add the package to your composer.json file:
Then you have to run composer update to install the package. Once this is completed, you have to add the service provider in bootstrap/app.php:
Copy config/annotations.php from this package to your configuration directory to use a custom configuration file.
Include generated routes
Once you have run php artisan route:scan (see below), you have to include the generated routes.php file in your bootstrap/app.php file:
Include generated event bindings
After you have executed php artisan event:scan (see below), you have to add the service provider to the providers array in config/app.php:
Usage
By using annotations you can define your routes directly in your controller classes and your event bindings directly in your event handlers (see examples for usage of annotations).
Class Annotations
For routes:
| Annotation | Description |
|---|---|
@Controller |
This annotation must be set to indicate that the class is a controller class. Optional parameters prefix and middleware. |
@Resource |
First parameter is resource name. Optional parameters only and except. |
@Middleware |
First parameter is middleware name. |
For events:
| Annotation | Description |
|---|---|
@Hears |
This annotation binds an event handler class to an event. |
Method Annotations
For routes:
| Annotation | Description |
|---|---|
@Get,br>`@Delete`, |
First parameter is route url. Optional parameters as and middleware. |
@Middleware |
First parameter is middleware name. |
Commands
After you have defined the routes and event bindings via annotations, you have to run the scan command:
- Use
php artisan route:scanto register all routes. - Use
php artisan route:clearto clear the registered routes. - Use
php artisan event:scanto register all event bindings. - Use
php artisan event:clearto clear the registered events.
Examples
Example #1
Example #2
Example #3
Support
Bugs and feature requests are tracked on GitHub.
License
This package is released under the MIT License.
