Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lorisleiva/laravel-actions
⚡️ Laravel components that take care of one specific task
https://github.com/lorisleiva/laravel-actions
Last synced: 15 days ago
JSON representation
⚡️ Laravel components that take care of one specific task
- Host: GitHub
- URL: https://github.com/lorisleiva/laravel-actions
- Owner: lorisleiva
- License: mit
- Created: 2019-03-27T10:26:30.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T09:58:00.000Z (2 months ago)
- Last Synced: 2024-10-16T06:23:02.135Z (28 days ago)
- Language: PHP
- Homepage: https://laravelactions.com
- Size: 572 KB
- Stars: 2,492
- Watchers: 32
- Forks: 123
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# ⚡️ Laravel Actions
[](https://packagist.org/packages/lorisleiva/laravel-actions)
[](https://github.com/lorisleiva/laravel-actions/actions?query=workflow%3ATests+branch%3Amain)
[](https://packagist.org/packages/lorisleiva/laravel-actions)
⚡ **Classes that take care of one specific task.**
This package introduces a new way of organising the logic of your Laravel applications by focusing on the actions your applications provide.
Instead of creating controllers, jobs, listeners and so on, it allows you to create a PHP class that handles a specific task and run that class as anything you want.
Therefore it encourages you to switch your focus from:
> "What controllers do I need?", "should I make a FormRequest for this?", "should this run asynchronously in a job instead?", etc.
to:
> "What does my application actually do?"
## Installation
```bash
composer require lorisleiva/laravel-actions
```
## Documentation
:books: Read the full documentation at [laravelactions.com](https://laravelactions.com/)
## Basic usage
Create your first action using `php artisan make:action PublishANewArticle` and define the `asX` methods when you want your action to be running as `X`. E.g. `asController`, `asJob`, `asListener` and/or `asCommand`.
``` php
class PublishANewArticle
{
use AsAction;
public function handle(User $author, string $title, string $body): Article
{
return $author->articles()->create([
'title' => $title,
'body' => $body,
]);
}
public function asController(Request $request): ArticleResource
{
$article = $this->handle(
$request->user(),
$request->get('title'),
$request->get('body'),
);
return new ArticleResource($article);
}
public function asListener(NewProductReleased $event): void
{
$this->handle(
$event->product->manager,
$event->product->name . ' Released!',
$event->product->description,
);
}
}
```
### As an object
Now, you can run your action as an object by using the `run` method like so:
```php
PublishANewArticle::run($author, 'My title', 'My content');
```
### As a controller
Simply register your action as an invokable controller in a routes file.
```php
Route::post('articles', PublishANewArticle::class)->middleware('auth');
```
### As a listener
Simply register your action as a listener of the `NewProductReleased` event.
```php
Event::listen(NewProductReleased::class, PublishANewArticle::class);
```
Then, the `asListener` method of your action will be called whenever the `NewProductReleased` event is dispatched.
```php
event(new NewProductReleased($manager, 'Product title', 'Product description'));
```
### And more...
On top of running your actions as objects, controllers and listeners, Laravel Actions also supports jobs, commands and even mocking your actions in tests.
📚 [Check out the full documentation to learn everything that Laravel Actions has to offer](https://laravelactions.com/).