🔥 Fire events on attribute changes of your Eloquent model

When casting attributes with protected $casts = [] the changes are not picked up and the relative events are not fired, for example I am using spatie/laravel-model-states to keep the status of a request with the following $casts:

protected $casts = [
     'status' => RequestStatus::class,
];

And the following $dispatchesEvents:

protected $dispatchesEvents = [
      'created' => RequestCreated::class,
      'status:confirmed' => RequestConfirmed::class,
      'status:repaired' => RequestCompletedIntervention::class,
];

In this case the events are not fired because the Trait AttributeEvents compares the values like this on line 64: $value === $expected, but because of the cast my value is not a string but an instance of a RequestStatus. Comparing the values with $value == $expected works because the RequestStatus can be cast to a string. I tried adding $this->castAttribute($attribute, $expected) but I keep getting the current value of the attribute and not the $expected value I want to cast, I don't know if it's how laravel is supposed to work. For now I ended up doing $value = $this->getAttributes()[$attribute]; on line 32 and I get the expected resault

• renamed test folder to tests
• added phpunit configuration file
• added phpcs cache and test cache files to gitignore
• fixed paths to make tests pass again
• added github action for the PHP CS FIXER

Add support for PHP 8.1 Enums by converting the value to a string if the attribute is casted to a backed enum.

Related: https://github.com/jpkleemans/attribute-events/issues/11

I see that the package supports castables however, it doesn't support enums.

Here's example model:

<?php

namespace App\Models;

use App\Enums\OrderFinancialStatus;
use App\Events\Orders\OrderCreated;
use App\Events\Orders\OrderPaid;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Kleemans\AttributeEvents;

class Order extends Model
{
    use HasFactory,
        AttributeEvents;

    protected $dispatchesEvents = [
        'created' => OrderCreated::class,
        'status:financial_status' => OrderPaid::class,
    ];

    protected $casts = [
        'financial_status' => OrderFinancialStatus::class,
    ];
}

When financial_status is changed to paid, the package fails with the following error:

1) Tests\Feature\Models\OrderTest::test_it_dispatched_order_paid_event
Error: Object of class App\Enums\OrderFinancialStatus could not be converted to string

/app/vendor/jpkleemans/attribute-events/src/AttributeEvents.php:64
/app/vendor/jpkleemans/attribute-events/src/AttributeEvents.php:15
/app/vendor/laravel/framework/src/Illuminate/Events/Dispatcher.php:421
/app/vendor/laravel/framework/src/Illuminate/Events/Dispatcher.php:249
/app/vendor/laravel/framework/src/Illuminate/Support/Testing/Fakes/EventFake.php:262
/app/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Concerns/HasEvents.php:189
/app/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:1078
/app/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:989
/app/tests/Feature/Models/OrderTest.php:33

Here's the test case I used:

    public function test_it_dispatched_order_paid_event()
    {
        Event::fake([
            OrderPaid::class,
        ]);

        $order = Order::withoutEvents(fn () => Order::factory()->createOne());
        $order->financial_status = OrderFinancialStatus::PAID;
        $order->save();

        Event::assertDispatched(fn (OrderPaid $event) => $event->order->id === $order->id);
    }

I tried finding a workaround for this, though with no luck. I tried:

• adding __toString() to enum - not possible
• using a custom getter

// Edit

I'm attaching the missing enum:

enum OrderFinancialStatus: string
{
    case PAID = 'paid';
}

Hi! Great package and well documented, thanks a lot!

Question: Do you have an idea how to dispatch an event when a value in a json-column changes? Like:

protected $dispatchesEvents = [
  'settings->color:*' => ColourChanged::class,
]

The example above doesn't seems to work.

Jeffrey

We want to fire an event when any one of several DB columns are updated on our User model. This event reaches out to an external API and updates other columns on the User model. The problem we're running into is that the event is being fired multiple times if multiple attribute events are a hit. Here is what our definition looks like:

protected $dispatchesEvents = [
        'birthdate:*'         => UserBirthInfoChanged::class,
        'birthtime:*'         => UserBirthInfoChanged::class,
        'birthplace:*'    => UserBirthInfoChanged::class,
    ];

Obviously we want to fire UserBirthInfoChanged when ANY of those columns are updated. But only once for any given update. I'm not sure if this is currently possible, but looking at the fireAttributeEvents method, it doesn't seem like it is.

Bumps illuminate/database from 8.39.0 to 8.40.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps illuminate/database from 8.22.0 to 8.22.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Hello I have an event fired when the image attribute was changed. I want to remove the old image from S3 bucket when a resource was updated.

How is the best way to do that?