jeanlrnt/laravel-cancellable

An cancellable trait package for Laravel Eloquent models

1.3 2023-09-13 15:21 UTC

Requires

• php: ^7.3|^8.0
• illuminate/database: ^7.0|^8.0|^9.0|^10.0
• illuminate/support: ^7.0|^8.0|^9.0|^10.0

Requires (Dev)

• illuminate/pagination: ^7.0|^8.0|^9.0|^10.0
• orchestra/testbench: ^6.3|^7.0|^8.0
• phpunit/phpunit: ^8.4|^9.1

MIT

• Jean Laurent

• laravel
• laravel-cancellable

README

A simple package for making Laravel Eloquent models 'cancellable'. This package allows for the easy cancelling of models by creating various macros to be used within method chaining.

Installation

This package requires PHP 7.3 or higher and Laravel 6.0 or higher.

You can install the package via composer:

composer require jeanlrnt/laravel-cancellable

Usage

Migrations

The Cancellable trait works similarly to Laravel's SoftDeletes trait. This package also ships with a helpful macro for Laravel's \Illuminate\Database\Schema\Blueprint. To get started, simply add the cancelledAt macro to your migration, like so:

Schema::create('posts', function (Blueprint $table) {
    $table->id();
    $table->unsignedBigInteger('user_id');
    $table->string('title');
    $table->timestamps();
    $table->cancelledAt(); // Macro
});

Eloquent

You can now, safely, include the Cancellable trait in your Eloquent model:

namespace App\Models;

use \Illuminate\Database\Eloquent\Model;
use \LaravelCancellable\Cancellable;

class Post extends Model {

    use Cancellable;
    ...
}

Extensions

The extensions shipped with this trait include; cancel, unCancel, withCancelled, withoutCancelled, onlyCancelled and can be used accordingly:

$user = User::first();
$user->cancel();
$user->unCancel();

$usersWithCanceled = User::query()->withCanceled();
$onlyCanceledUsers = User::query()->onlyCanceled();

By default, the global scope of this trait uses the withoutCanceled extension when the trait is added to a model.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Joel Butcher

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.