inmanturbo/modelware

Eloquent Modelware for laravel

v1.0.3 2024-08-10 20:52 UTC

This package is auto-updated.

Last update: 2024-12-10 21:34:50 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

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.