Laravel Model Flags Package

 Laravel Model Flags is a package by Spatie to allow you to add flags to an Eloquent model:

This package adds a HasFlags trait to Eloquent models enabling you to query models that are either flagged or not flagged. The trait includes relations, model scopes, and other methods for working with flags:

use Illuminate\Database\Eloquent\Model;
use Spatie\ModelFlags\Models\Concerns\HasFlags;
 
class User extends Model
{
    use HasFlags;
}

The package also supports a configurable "flag" model, if you want/need to override the default model that backs model flags.

Using the above model, an example in the readme shows that you can "easily build idempotent (aka restartable) pieces of code":

User::notFlagged('wasSentPromotionMail')
    ->each(function(User $user) {
        Mail::to($user->email)->send(new PromotionMail())
 
        $user->flag('wasSentPromotionMail');
    });
});

The example code only runs for users not flagged, therefore, the code will skip them on subsequent calls. Without the above code, you'd have to find some way to track whether the code sent the user an email in the event of a failure.

This package also opens up general model flagging use-cases, such as things like rolling out a new feature to a subset of users:

$user->hasFlag('someExperimentalFeature'); // returns bool
 
// Flag the user for someExperimentalFeature
$user->flag('someExperimentalFeature');
 
// Now the flag returns true
$user->hasFlag('someExperimentalFeature');
 
// Get all users with the flag
User::flagged('someExperimentalFeature')->get();
 
// Get all users without the flag
User::notFlagged('someExperimentalFeature')->get();

You can learn more about this package, get full installation instructions, and view the source code on GitHub. Also, read A Laravel package to add flags to Eloquent models, which has background details on why Spatie created this package and their primary use case.

Read More

Multi-purpose Value Objects for Laravel

 Laravel Value Objects is a collection of general-purpose value objects you can use in your Laravel application. Value objects help represent simple entities such as money or X/Y coordinates on a 2D axis. Specifically, this package offers the following value objects you'd typically run into:

• Boolean
• Number
• Text
• Email
• Full Name
• Name
• Tax Number
• UUID

Take working with a user's full name, for example you might need to split up a name string into a first and last name:

$name = new FullName(' Joe User ');
 
$name->fullName(); // 'Joe User'
$name->firstName(); // 'Joe'
$name->lastName(); // 'User'

This package also provides some Laravel-specific goodies, such as extending value objects via Laravel's Macroable trait and Laravel's Conditionable trait, which applies a callback when a condition is "truthy":

TaxNumber::from('PL0123456789')
    ->when(function ($number) {
        return $number->prefix() !== null;
    })
    ->prefix();

Another example is the Number value object, which you can use to scale numbers for example:

$number = new Number('10.20999', scale: 2);
$number = Number::make('10.20999', scale: 2);
$number = Number::from('10.20999', scale: 2);
 
$number->value();   // '10.20'
(string) $number;   // '10.20'
$number->toArray(); // ['10.20']

As you can also see, this package provides a few static constructors you can use to create a value object and handle invalid data via the makeOrNull() static constructor.

You can learn more about this package, get full installation instructions, and view the source code on GitHub. The readme has documentation on how to use each of the provided value objects.

Read More