inmanturbo / modelware
Eloquent Modelware for laravel
Requires
- php: ^8.2
- illuminate/contracts: ^10.0||^11.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^2.9
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1||^7.10.0
- orchestra/testbench: ^9.0.0||^8.22.0
- pestphp/pest: ^2.34
- pestphp/pest-plugin-arch: ^2.7
- pestphp/pest-plugin-laravel: ^2.3
- phpstan/extension-installer: ^1.3
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-phpunit: ^1.3
README
Installation
You can install the package via composer:
composer require inmanturbo/modelware
Usage
Add modelware in the boot method of a service provider
use Inmanturbo\Modelware\Facades\Modelware; Modelware::add('eloquent.updating*', [ EnsureModelShouldBeSaved::class, ValidateAttributes::class, FillModel::class, ], prefix: 'modelware'); // modelware is the default
This package sends the event data through pipelines (similiar to middleware), which iterate through collections of invokable classes, these collections are bound into and resolved from the service container using the following syntax:
app()->bind("{$prefix}.{$event}", function () use ($pipes) { return collect($pipes)->map(fn ($pipe) => app($pipe)); });
Where the {$event}
is a wildcard event for eloquent:
modelware.eloquent.creating*
=>eloquent.creating*
modelware.eloquent.updating*
=>eloquent.updating*
modelware.eloquent.deleting*
=>eloquent.deleting*
This package will send the following data object through your custom pipeline:
$data = app(Data::class, [ 'event' => $events, 'model' => $payload[0], 'payload' => $payload, ]);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.