signifly/laravel-cancellation

A laravel cancellation package.

Cancel models inside your Laravel app

, _(*1)

The signifly/laravel-cancellation package allows you to easily handle cancellation of your models. It is inspired by the SoftDeletes implementation in Laravel., _(*2)

All you have to do to get started is:, _(*3)

// 1. Add cancelled_at column to your table by using our macro cancellable
Schema::create('orders', function (Blueprint $table) {
    // ...
    $table->cancellable();
    // ...
});

// 2. Add the Cancellable trait to your model
class Order extends Model
{
    use Cancellable;
}

Here's a little demo of how you can use it after adding the trait:, _(*4)

$order = Order::find(1);
$order->cancel();

You can query cancelled entities:, _(*5)

$orders = Order::onlyCancelled()->get(); // returns all the cancelled entities
$orders = Order::withCancelled()->get(); // includes cancelled entities
$orders = Order::withoutCancelled()->get(); // excludes cancelled entities

Other useful methods:, _(*6)

$order->isCancelled(); // returns true or false
$order->keep(); // keep a cancelled order

Order::whereKey([1, 2, 3])->keep(); // keeps orders with ids: 1, 2, 3

Installation

You can install the package via composer:, _(*7)

$ composer require signifly/laravel-cancellation

The package will automatically register itself., _(*8)

You can publish the config with:, _(*9)

$ php artisan vendor:publish --provider="Signifly\Cancellation\CancellationServiceProvider" --tag="config"

Note: If you set the exclude variable to true in your config, your query results will not include cancelled results by default (just like SoftDeletes)., _(*10)

This is the contents of the published config file:, _(*11)

return [
    /**
     * Exclude the cancellations from the model's queries.
     * Will apply to all, find, etc.
     */
    'exclude' => false,
];

Testing

$ composer test

Security

If you discover any security issues, please email dev@signifly.com instead of using the issue tracker., _(*12)

Credits

• Morten Poul Jensen
• All contributors

License

The MIT License (MIT). Please see License File for more information., _(*13)