Replace ReactionCounter & ReactionTotal observers with attribute casting

[antonkomarev]

One of the possible things I want to remove - ReactionCounterObserver & ReactionTotalObserver classes.

They were very useful before adding default count and weight attribute values:

• Resolving default attributes values moved from accessors to Eloquent #87

Right now they are covering only one case - when you are trying to create counter with null values:

$total = $reactant->reactionTotal()->create([
    'count' => null,
    'weight => null,
]);

$counter = $reactant->reactionCounters()->create([
    'reaction_type_id' => $reactionType->getId(),
    'count' => null,
    'weight' => null,
]);

While these code will create models with default count & weight values without any issues:

$total = $reactant->reactionTotal()->create();

$counter = $reactant->reactionCounters()->create([
    'reaction_type_id' => $reactionType->getId(),
]);

But we have a way to define default values for nulls.

[antonkomarev]

Solution №1

Magic Eloquent Model methods.

public function setCountAttribute(
    int | null $count,
): void {
    $this->attributes['count'] = $count ?? self::COUNT_DEFAULT;
}

public function setWeightAttribute(
    float | null $weight,
): void {
    $this->attributes['weight'] = $weight ?? self::WEIGHT_DEFAULT;
}

[antonkomarev]

Solution №2

Eloquent Model attribute casters.

protected $casts = [
    'count' => IntegerCast::class,
    'weight' => FloatCast::class,
];

final class IntegerCast implements CastsAttributes
{
    /**
     * Cast the given value.
     *
     * @param array<string, mixed> $attributes
     */
    public function get(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): int {
        return $value;
    }

    /**
     * Prepare the given value for storage.
     *
     * @param array<string, mixed> $attributes
     */
    public function set(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): int {
        return intval($value);
    }
}

[antonkomarev]

Solution №3

public function count(): Attribute
{
    return Attribute::make(
        set: fn (int | null $value) => $value ?? self::COUNT_DEFAULT,
    );
}

public function weight(): Attribute
{
    return Attribute::make(
        set: fn (float | null $value) => $value ?? self::WEIGHT_DEFAULT,
    );
}

[antonkomarev]

I'd prefer to stick to this solution, since it's more modern and obvious place to find attribute setters.

[antonkomarev]

• Implementation Refactor Eloquent Model Attributes casting #251