Laravel Model Flags is an awesome package that offers a trait that allows you to add flags to an Eloquent model. These can be used to quickly save the state of a process, update, migration, etc… to a model, without having to add an additional column using migrations.

$user->hasFlag('receivedMail'); // returns false

$user->flag('receivedMail'); // flag the user as having received the mail

$user->hasFlag('receivedMail'); // returns true

Installation

You can install the package via Composer:

composer require spatie/laravel-model-flags

Behind the scenes, the flags and their relation to a model will be stored in the flags table.

To create that flags table, you must publish and run the migrations once with:

php artisan vendor:publish --tag="model-flags-migrations"
php artisan migrate

Optionally, you can publish the config file with:

php artisan vendor:publish --tag="model-flags-config"

Usage

To add flaggable behavior to a model, simply make it use the.

Spatie\ModelFlags\Models\Concerns\HasFlags trait

use Illuminate\Database\Eloquent\Model;
use Spatie\ModelFlags\Models\Concerns\HasFlags;

class YourModel extends Model
{
    use HasFlags;
}

These functions will become available.

// add a flag
$model->flag('myFlag');

// returns true if the model has a flag with the given name
$model->hasFlag('myFlag');

// remove a flag
$model->unflag('myFlag');

 // returns an array with the name of all flags on the model
$model->flagNames();

// use the `flags` relation to delete all flags on a model
$user->flags()->delete();

// use the `flags` relation to delete a particular flag on a model
$user->flags()->where('name', 'myFlag')->delete();

You’ll also get these scopes:

// query all models that have a flag with the given name
YourModel::flagged('myFlag');

// query all models that have do not have a flag with the given name
YourModel::notFlagged('myFlag');
To remove a flag from all models in one go, you can delete the flag using the Spatie\ModelFlags\Models\Flag model.

use Spatie\ModelFlags\Models\Flag;

// remove myFlag from all models
Flag::where('name', 'myFlag')->delete();

For more details, please visit Github.

Closing Note

Codebrisk is here to help you grow your business. Our expert developers have plenty of experience in Laravel Custom Web Application Development. We can enhance the performance of applications with easy syntax, third-party API integrations, and built-in functions, followed by a high level of security to prevent unauthorized access to data. We always provide a customized website solution tailored to our client’s needs. So if you’re interested, you can get in touch with us or get a free quote from us.