Download the PHP package maslauskas/event-store without Composer
On this page you can find all versions of the php package maslauskas/event-store. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download maslauskas/event-store
More information about maslauskas/event-store
Files in maslauskas/event-store
Package event-store
Short Description Simple event store for Laravel using MySQL
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package event-store
event-store
Simple EventStore implementation package for Laravel using MySQL.
Installation
To start using this package, install it with composer:
Publishing config and migrations:
This package uses Laravel's package auto-discovery feature, so there is no need to modify your config/app.php file.
Configuration
Event Store logs are saved to your main database by default, but it is recommended to use a dedicated MySQL database for it. Once you create the database, make sure to set Event Store to use it:
First, add a dedicated connection to your config/database.php file:
Next, add required environment variables to your .env file:
It is recommended to create a separate user for event store database, and remove UPDATE, DELETE, DROP permissions, to make sure your event store is append-only.
Next, run the migration to create default event store table:
Usage
To start logging your events, append this line to your code where you wish the event to be logged:
Or using the eventstore helper function, which is just a wrapper for the facade:
the add() method accepts four arguments:
$event_type: name of your event, e.g.user_created,email_sent,order_shipped, etc.$payload: array of values to record. e.g. foruser_createdevent, you can pass the array of attributes that this user was created with.$target_id: (optional) ID of target model in your database. E.g., foremail_sentevent, you can passuser_idas$target_id. This helps in the future when you wish to fetch all events related to a particular user.$before: (optional) array of values that were changed. E.g. foruser_updatedevent, you may pass$user->toArray()to record attributes that were changed and their values before the change. Note: theadd()method automatically filters out only those keys that exist in$payloadparameter to avoid unnecessary overhead.
Sometimes, certain events occur much more frequently than others, e.g. user_created and user_logged_in. To help with query performance, you can separate certain events to their dedicated tables by changing the streams array in config/eventstore.php file:
This will automatically create a dedicated user_login_stream table in your event store database when you try to add user_logged_in event. All events that are not defined in this array will be saved in the default event store table.
Extra methods
query()
Returns Illuminate\Database\Eloquent\Builder instance so you can perform any query on event store tables.
get()
Gets all events from the default event store table. Returns a collection.
get($event_name)
Gets all events of specific type from event store table. Automatically determines which table to search in. Returns a collection.
stream($stream_name)
Sets dedicated table and returns Illuminate\Database\Eloquent\Builder instance so you can perform any query on event store tables.
Exception handling
By default, EventStore suppresses any exceptions that occur during add() method call. You can disable this by changing throw_exceptions setting in config/eventstore.php:
Testing
Run the tests with
