https://github.com/inmanturbo/modelware

https://github.com/inmanturbo/modelware

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/inmanturbo/modelware
• Owner: inmanturbo
• License: mit
• Created: 2024-08-08T17:53:14.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-10T20:53:44.000Z (3 months ago)
• Last Synced: 2024-08-16T09:09:42.939Z (3 months ago)
• Language: PHP
• Size: 41 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Eloquent Modelware for laravel

[![Latest Version on Packagist](https://img.shields.io/packagist/v/inmanturbo/modelware.svg?style=flat-square)](https://packagist.org/packages/inmanturbo/modelware)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/inmanturbo/modelware/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/inmanturbo/modelware/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/inmanturbo/modelware/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/inmanturbo/modelware/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/inmanturbo/modelware.svg?style=flat-square)](https://packagist.org/packages/inmanturbo/modelware)

## Installation

You can install the package via composer:

```bash

composer require inmanturbo/modelware

```

## Usage

Add modelware in the boot method of a service provider

```php

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](https://laravel.com/docs/11.x/helpers#pipeline) (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:

```php

    app()->bind("{$prefix}.{$event}", function () use ($pipes) {

        return collect($pipes)->map(fn ($pipe) => app($pipe));

    });

```

Where the `{$event}` is a [wildcard event](https://laravel.com/docs/11.x/events#wildcard-event-listeners) 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:

```php

$data = app(Data::class, [

    'event' => $events,

    'model' => $payload[0],

    'payload' => $payload,

]);

```

## Testing

```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.

## Credits

- [inmanturbo](https://github.com/inmanturbo)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.