robin-malfait/event-sourcing

An EventSourcing Package

EventSourcing

, _(*1)

This is a simple EventSourcing package that you can use in your projects. This project is written using PSR2, _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require robin-malfait/event-sourcing, <sub>(*4)</sub>

## Usage

Register the service provider

``` php
'providers' => [
    ...
    \EventSourcing\Laravel\EventSourcingServiceProvider::class,
]

Publish the configuration file, <sub>(*5)</sub>

``` php php artisan vendor:publish --provider="EventSourcing\Laravel\EventSourcingServiceProvider", <sub>(*6)</sub>

The config file looks like this:

[Config File](src/Laravel/Config/event_sourcing.php)

You can now tweak some configurations

Last but not least make the event store table:

php artisan event-sourcing:table, <sub>(*7)</sub>

## Update v1 to v2

If you are still using the first version you better update to version 2.
You will have less problems in the future, I promise.

In Version 2 we give each DomainEvent the responsibility to give data and receive data.
Those methods are 

> `serialize();` Which returns an array of serialized  data
>
> `deserialize(array $data);` Which has a parameter with the data that basically comes from the serialize method. This method should also return an instance of the current event.

### For Example:


```php 
<?php namespace App\Users\Events;

use EventSourcing\Domain\DomainEvent;

class UserWasRegistered implements DomainEvent
{
    private $user_id;

    private $email;

    private $password; // Yes, this is encrypted

    public function __construct($user_id, $email, $password)
    {
        $this->user_id = $user_id;
        $this->email = $email;
        $this->password = $password;
    }

    /**
     * @return UserId
     */
    public function getAggregateId()
    {
        return $this->user_id;
    }

    public function getMetaData() 
    {
        return []; // Could be for example the logged in user, ...
    }

    /**
     * @return array
     */
    public function serialize()
    {
        return [
            'user_id' => $this->user_id,
            'email' => $this->email,
            'password' => $this->password
        ];
    }

    /**
     * @param array $data
     * @return mixed
     */
    public static function deserialize(array $data)
    {
        return new static(
            $data['user_id'],
            $data['email'],
            $data['password']
        );
    }
}

Once you have defined every serialize / deserialize method in your events you can start the migration process., <sub>(*8)</sub>

In your database rename eventstore to eventstore_backup, <sub>(*9)</sub>

Now you can run the following command in your terminal:, <sub>(*10)</sub>

php artisan event-sourcing:table

This will create the eventstore, now you should see 2 tables in your database, <sub>(*11)</sub>

1. eventstore_backup => Your old table with all data in
2. eventstore => Your new empty table

I also have written a helper method to do the migration now., <sub>(*12)</sub>

php artisan event-sourcing:1to2 eventstore_backup eventstore

Or you can also just run the following command because eventstore_backup and eventstore are the defaults., <sub>(*13)</sub>

php artisan event-sourcing:1to2

Testing

bash $ composer test, <sub>(*14)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*15)</sub>

Security

If you discover any security related issues, please email malfait.robin@gmail.com instead of using the issue tracker., <sub>(*16)</sub>

Credits

• Robin Malfait
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*17)</sub>