prooph/event-store
PHP EventStore Implementation
Requires
- php: ~5.5|~7.0
- beberlei/assert: ~2.3
- prooph/common: ~3.7
Requires (Dev)
- container-interop/container-interop: ^1.1
- sandrokeil/interop-config: ^1.0
- ramsey/uuid: ~2.8
- phpunit/phpunit: ~4.8
- friendsofphp/php-cs-fixer: ^1.12.0
- satooshi/php-coveralls: ^1.0
- zendframework/zend-servicemanager: ~2.6
- tobiju/bookdown-bootswatch-templates: ^1.0
- malukenho/docheader: ^0.1.3
Suggests
- container-interop/container-interop: For usage of provided factories
- prooph/event-sourcing: Basic functionality for event sourced aggregates
- prooph/event-store-doctrine-adapter: For usage with doctrine dbal as event store adapter
- prooph/event-store-flywheel-adapter: For usage with flywheel as event store adapter
- prooph/event-store-mongodb-adapter: For usage with mongodb as event store adapter
- prooph/service-bus: Message bus facade to connect the event store with messaging systems
- prooph/snapshot-doctrine-adapter: For usage with doctrine dbal as snapshot adapter
- prooph/snapshot-memcached-adapter: For usage with memcached as snapshot adapter
- prooph/snapshot-mongodb-adapter: For usage with mongodb as snapshot adapter
- sandrokeil/interop-config: For usage of provided factories
Conflicts
README
PHP 5.5+ EventStore Implementation.
Overview
Prooph Event Store is capable of persisting event messages that are organized in streams. Prooph\EventStore\EventStore
itself is a facade for different persistence adapters (see the list below) and adds event-driven hook points for Prooph\EventStore\Plugin\Plugins
which make the Event Store highly customizable.
Installation
You can install prooph/event-store via composer by adding "prooph/event-store": "^6.0" as requirement to your composer.json.
Available Persistence Adapters
- Mongo DB - stable
- Doctrine DBAL - stable
Available Snapshot Adapters
- Mongo DB - stable
- Doctrine DBAL - stable
- Memcached - stable
Quick Start
For a short overview please see the annotated Quickstart in the examples folder.
Documentation
Documentation is in the doc tree, and can be compiled using bookdown.
$ php ./vendor/bin/bookdown docs/bookdown.json $ php -S 0.0.0.0:8080 -t docs/html/
Then browse to http://localhost:8080/
Support
- Ask questions on prooph-users mailing list.
- File issues at https://github.com/prooph/event-store/issues.
- Say hello in the prooph gitter chat.
Contribute
Please feel free to fork and extend existing or add new plugins and send a pull request with your changes! To establish a consistent code quality, please provide unit tests for all your changes and may adapt the documentation.
License
Released under the New BSD License.