Laravel Event Sourcing Laravel Package

title: Preparing events weight: 1

The package will listen for events that extend the \Spatie\EventSourcing\StoredEvents\ShouldBeStored class. This is an abstract class that signals to the package that the event should be stored.

You can quickly create an event that extends ShouldBeStored by running this artisan command:

php artisan make:storable-event NameOfYourEvent

Here's an example of such event:

namespace App\Events;

use Spatie\EventSourcing\StoredEvents\ShouldBeStored;

class MoneyAdded extends ShouldBeStored
{
    /** [@var](https://github.com/var) string */
    public $accountUuid;

    /** [@var](https://github.com/var) int */
    public $amount;

    public function __construct(string $accountUuid, int $amount)
    {
        $this->accountUuid = $accountUuid;

        $this->amount = $amount;
    }
}

Whenever an event that implements ShouldBeStored is fired it will be serialized and written in the stored_events table. Immediately after that, the event will be passed to all projectors and reactors.

Specifying a queue

When a StoredEvent is created, we'll dispatch a job on the queue defined in the queue key of the event-sourcing config file. Queued projectors and reactors will get called when the job is executed on the queue.

On an event you can override the queue that should be used by adding a queue property.

namespace App\Events;

use Spatie\EventSourcing\StoredEvents\ShouldBeStored;

class MyEvent extends ShouldBeStored
{
    public $queue = 'alternativeQueue';

    ...
}