Download the PHP package bernskiold/laravel-activatable without Composer

Activate and deactivate Eloquent models, the easy way

Almost every app has models that can be turned on and off — users, products, feature flags, integrations. This package gives those models a clean active/inactive state, so you stop re-writing the same is_active boolean, the same scopes, and the same factory states in every project.

Add one trait, add one column, and you're done. Everything else — scopes, events, factory states, an optional "when was this turned off?" timestamp — is there when you want it and out of the way when you don't.

Why you'll like it

• One trait, zero ceremony. New records default to active, the column is cast to a boolean, and you get activate() / deactivate() / toggleActive() for free.
• Readable scopes. Product::active() and Product::inactive() read like English, and invert with a single argument.
• Idempotent by design. Calling deactivate() on an already-inactive model is a true no-op — no redundant write, no misleading event.
• Events when it matters. ModelActivated and ModelDeactivated fire only when the state actually changes, so listeners aren't spammed.
• Optional deactivation timestamp. Opt in to an inactivated_at column and the package keeps it in sync — set on deactivation, cleared on activation.
• Tidy migrations and factories. A $table->activatable() schema macro and active() / inactive() factory states keep your test and migration code expressive.

Installation

You can install the package via Composer:

If you'd like to change the column name, the default state, or enable the deactivation timestamp globally, publish the config:

Schema

Add the boolean column with the activatable() blueprint macro:

Both schema macros return the column definition, so you can keep chaining:

Usage

Add the trait to your model:

New records are active by default. From there:

Calling activate() / deactivate() on a model that is already in the requested state does nothing at all — no query is run and no event is dispatched.

Need to change the state without firing events (and without touching the model's own saving/saved events)? Reach for the quiet variants:

Events

activate() and deactivate() dispatch events only when the state actually changes. Each event exposes the $model that changed:

Tracking when a model was deactivated

Sometimes "is it off?" isn't enough — you want to know when it was switched off. Opt a model into an inactivated_at timestamp and the package keeps it in sync: it's set on deactivation and cleared again on activation.

Add the column with the inactivatedAt() macro (or enable it for every model via the track_inactivated_at config option):

Factory states

Add the factory trait for expressive active() / inactive() states. They respect the model's column (and the deactivation timestamp, if it tracks one):

A different column name

Override the column globally in config/activatable.php, or per model with a constant:

Type-hinting

The trait implements the Bernskiold\LaravelActivatable\Contracts\Activatable interface, so you can type-hint against any activatable model:

Testing

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

• Erik Bernskiöld
• All Contributors

License

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