53 |
74 |
75 | ## Specialized Scalar Types
76 |
77 | ### vo_uuid
78 |
79 | A UUID value object template is included, too. It works with the well known [ramsey/uuid](https://github.com/ramsey/uuid) library.
80 | Along with the `vo_uuid` template you also get a `use_uuid` template. Use them in combination like shown in the example:
81 |
82 | 
83 |
84 | ### vo_datetime
85 |
86 | The `vo_datetime` is another specialized scalar value object template. It uses PHP's built-in `\DateTimeImmutable`, ensures
87 | `UTC` is used as well as a standard format for from/to string conversion.
88 |
89 | The `FORMAT` constant can be used to change the format. By default it is `'Y-m-d\TH:i:s.u`, which is the same format as of the `Message::createdAt` property.
90 |
91 | 
92 |
93 | ## List / Collection
94 |
95 | If you need a list or collection with all items being of the same type you can use the `vo_collection` template. It generates quite a lot of code so that you can work with the list
96 | out-of-box. Feel free to add more methods, either to the template or after code generation if it is specific to the concrete class.
97 |
98 | The template needs two information:
99 |
100 | 1. The item class. The item class should at least have a `public static from
54 |
58 |
55 | 
56 |
57 |
56 |
59 |
63 |
60 | 
61 |
62 |
61 |
64 |
68 |
65 | 
66 |
67 |
66 |
69 |
73 |
70 | 
71 |
72 |
71 |
2 |
99 |
105 |
106 |
--------------------------------------------------------------------------------
/docs/front.php:
--------------------------------------------------------------------------------
1 | '));
7 | $tail = substr($html, strpos($html, '') + 9);
8 | $html = $lead . file_get_contents(__DIR__ . '/front.html') . $tail;
9 | file_put_contents($file, $html);
10 |
11 | (function (string $sourceDir, string $destDir) {
12 | function copy_dir(string $sourceDir, string $destDir) {
13 | if(!is_dir($destDir)) {
14 | mkdir($destDir);
15 | }
16 |
17 | $source = new DirectoryIterator($sourceDir);
18 |
19 | foreach ($source as $file) {
20 | if($file->isDot()) {
21 | continue;
22 | }
23 |
24 | if($file->isDir()) {
25 | copy_dir($sourceDir . '/' . $file->getFilename(), $destDir . '/' . $file->getFilename());
26 | continue;
27 | }
28 |
29 | $destFilename = $destDir . '/' . $file->getFilename();
30 |
31 | if(file_exists($destFilename)) {
32 | unlink($destFilename);
33 | }
34 |
35 | copy($sourceDir . '/' . $file->getFilename(), $destFilename);
36 | }
37 | };
38 |
39 | copy_dir($sourceDir, $destDir);
40 | })(__DIR__ . '/img', __DIR__ . '/html/img');
--------------------------------------------------------------------------------
/docs/img/Choose_Flavour.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/Choose_Flavour.png
--------------------------------------------------------------------------------
/docs/img/Choose_Flavour_no_h.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/Choose_Flavour_no_h.png
--------------------------------------------------------------------------------
/docs/img/Event_Engine_intro.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/Event_Engine_intro.png
--------------------------------------------------------------------------------
/docs/img/cqrs_messagebox_cockpit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/cqrs_messagebox_cockpit.png
--------------------------------------------------------------------------------
/docs/img/cqrs_messagebox_swagger.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/cqrs_messagebox_swagger.png
--------------------------------------------------------------------------------
/docs/img/prooph-logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/prooph-logo.png
--------------------------------------------------------------------------------
/docs/img/prooph_features.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/prooph_features.png
--------------------------------------------------------------------------------
/docs/img/tutorial_screen.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/img/tutorial_screen.png
--------------------------------------------------------------------------------
/docs/intro/about.md:
--------------------------------------------------------------------------------
1 | # About Event Engine
2 |
3 | Prooph Event Engine takes away all the boring, time consuming parts of event sourcing to speed up
4 | development of event sourced applications and increase the fun. It can be used for prototypes as well as full featured applications.
5 |
6 | ## Origin
7 |
8 | Event Engine was originally designed as a "workshop framework" for CQRS and Event Sourcing and is inspired by the **Dreyfus model**.
9 |
10 | ### Beginner friendly
11 |
12 | > The Dreyfus model distinguishes five levels of competence, from novice to mastery. At the absolute beginner level people execute tasks based on “rigid adherence to taught rules or plans”. Beginners need recipes. They don’t need a list of parts, or a dozen different ways to do the same thing. Instead what works are step by step instructions that they can internalize. As they practice them over time they learn the reasoning behind them, and learn to deviate from them and improvise, but they first need to feel like they’re doing something.
13 |
14 | (source: [https://lambdaisland.com/blog/25-05-2017-simple-and-happy-is-clojure-dying-and-what-has-ruby-got-to-do-with-it](https://lambdaisland.com/blog/25-05-2017-simple-and-happy-is-clojure-dying-and-what-has-ruby-got-to-do-with-it))
15 |
16 | ### Rapid Application Development
17 | It turned out that Event Engine is not only a very good CQRS and Event Sourcing learning framework but that the same concept
18 | can be used for rapid application development (RAD). RAD frameworks focus on developer happiness and coding speed.
19 | Both can be achieved by using conventions, which allow the framework to do a lot of work "under the hood"
20 | Developers can focus on the important part: **developing the application**.
21 |
22 | ## Event Engine Flavours
23 |
24 | Event Engine Flavours make it possible to turn a rapidly developed prototype into a rock solid application.
25 | You can switch from the default **PrototypingFlavour** to either the **FunctionalFlavour** or **OopFlavour**. Finally, you can implement your own
26 | Flavour to build your very own CQRS / ES framework.
27 |
28 | [Learn More](/tutorial/)
29 |
30 | ## Pros
31 |
32 | - Developed and maintained by prooph core team members
33 | - Ready-to-use [skeleton](https://github.com/event-engine/php-engine-skeleton)
34 | - Less code to write
35 | - Guided event sourcing
36 | - extension points to inject custom logic
37 | - Audit log from day one (no data loss)
38 | - Multi-Model-Store
39 | - Replay functionality
40 | - Projections based on domain events
41 | - PSR friendly http message box
42 | - OpenAPI v3 Swagger integration
43 |
44 | ## Cons
45 |
46 | - Not suitable for monolithic architectures
47 |
48 | ### You may want to use Event Engine if:
49 |
50 | - Your project is in an early stage and you need to try out different ideas or **deliver features very fast**
51 | - You want to establish a **Microservices architecture** rather than building a monolithic system
52 | - You want to automate business processes
53 | - You have to develop a workflow-oriented service
54 | - You're **new to the concepts** of CQRS and Event Sourcing and want to learn them
55 |
56 | ## Conclusion
57 |
58 | Try the [tutorial](/tutorial/) and build a prototype with Event Engine!
59 |
60 | ## Powered By
61 |
62 | [](http://prooph.de)
63 |
64 | Event Engine is maintained by the [prooph software team](http://prooph-software.de/).
65 | Prooph software offers commercial support and workshops for Event Engine as well as for the [prooph components](http://getprooph.org/).
66 |
67 | If you are interested please [get in touch](http://getprooph.org/#get-in-touch)
--------------------------------------------------------------------------------
/docs/news/2019-04-05_new_tutorial.md:
--------------------------------------------------------------------------------
1 | # Event Engine Tutorial Available
2 |
3 | {.alert .alert-light}
4 | *Written by Alexander Miertsch ([@codeliner](https://github.com/codeliner)) - CEO prooph software GmbH - prooph core team - 2019-04-05*
5 |
6 | Three weeks ago we've released the [first dev version of Event Engine](https://github.com/event-engine/php-engine/releases/tag/v0.1.0), which supersedes Event Machine.
7 | Now we reached another important milestone towards a stable release. Make sure to check out the brand new Event Engine tutorial: [https://event-engine.github.io/tutorial/](https://event-engine.github.io/tutorial/)
8 | along with a new [skeleton application](https://github.com/event-engine/php-engine-skeleton).
9 |
10 | ## Repo Split
11 |
12 | A prerequisite for the new skeleton was the repo split announced in the release notes of v0.1.
13 | All packages are listed on [GitHub](https://github.com/event-engine) and [Packagist](https://packagist.org/packages/event-engine/).
14 |
15 | ## Rewritten Tutorial
16 |
17 | The Event Engine tutorial is a rewrite of the previous Event Machine tutorial. The story is the same but it differs in many details like a changed skeleton structure and
18 | the usage of the new **MultiModelStore** feature, which replaces aggregate projections in the default skeleton set up. That said, even if you did the Event Machine tutorial before
19 | and think you know the basics, I highly recommend to do the new Event Engine tutorial again to quickly learn more about new features and structural changes.
20 |
21 | ## API Docs
22 |
23 | At the time of writing, many API docs are still outdated. You'll find a warning at the top of each page that still needs to be migrated.
24 |
25 | ## Immutable Objects
26 |
27 | We've added new documentation about how to quickly generate immutable objects using PHPStorm templates and the `event-engine/php-data` package.
28 | [Learn more](https://event-engine.github.io/api/immutable_state.html)
29 |
30 | ## Keep Up-To-Date
31 |
32 | Follow us on [twitter](https://twitter.com/prooph_software) and watch changes/releases on the [event-engine repos](https://github.com/event-engine)
33 |
--------------------------------------------------------------------------------
/docs/news/bookdown.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "News",
3 | "content": [
4 | {"2019-04-05": "2019-04-05_new_tutorial.md"}
5 | ],
6 | "tocDepth": 1,
7 | "numbering": false
8 | }
--------------------------------------------------------------------------------
/docs/tutorial/bonus_II.md:
--------------------------------------------------------------------------------
1 | # Bonus II - Unit and Integration Tests
2 |
3 | Unit testing the different parts of the application is easy. In most cases we have single purpose classes and
4 | functions that can be tested without mocking.
5 |
6 | ## Testing Aggregate functions
7 |
8 | Aggregate functions are pure which makes them easy to test. php-engine-skeleton provides some test helpers in
9 | `tests/BaseTestCase.php`, so, if you extend from that base class, you're ready to go. Add a the folders `Domain/Model` in `tests`
10 | and a class `BuildingTest` with the following content:
11 |
12 | ```php
13 | buildingId = Uuid::uuid4()->toString();
34 | $this->buildingName = 'Acme Headquarters';
35 | $this->username = 'John';
36 |
37 | parent::setUp();
38 | }
39 |
40 | /**
41 | * @test
42 | */
43 | public function it_checks_in_a_user()
44 | {
45 | //Prepare expected aggregate state
46 | $state = Building\State::fromArray([
47 | Building\State::BUILDING_ID => $this->buildingId,
48 | Building\State::NAME => $this->buildingName
49 | ]);
50 |
51 | //Use test helper UnitTestCase::makeCommand() to construct command
52 | $command = $this->makeCommand(Command::CHECK_IN_USER, [
53 | Building\State::BUILDING_ID => $this->buildingId,
54 | Building\State::NAME => $this->username,
55 | ]);
56 |
57 | //Aggregate functions yield events, we have to collect them with a test helper
58 | $events = $this->collectNewEvents(
59 | Building::checkInUser($state, $command)
60 | );
61 |
62 | //Another test helper to assert that list of recorded events contains given event
63 | $this->assertRecordedEvent(Event::USER_CHECKED_IN, [
64 | Payload::BUILDING_ID => $this->buildingId,
65 | Payload::NAME => $this->username
66 | ], $events);
67 | }
68 | }
69 |
70 | ```
71 | You can run tests with:
72 |
73 | ```bash
74 | docker-compose run php php vendor/bin/phpunit -vvv
75 | ```
76 |
77 | ## Testing Projectors
78 |
79 | Testing projectors is also easy when they use the `DocumentStore` API to manage projections. Event Engine ships with
80 | an `InMemoryDocumentStore` implementation that works great in test cases. Here is an example:
81 |
82 | *tests/Domain/Projector/UserBuildingListTest.php*
83 | ```php
84 | projector = new UserBuildingList($this->documentStore);
114 | $this->projector->prepareForRun(
115 | self::PRJ_VERSION,
116 | Projection::USER_BUILDING_LIST
117 | );
118 | }
119 |
120 | /**
121 | * @test
122 | */
123 | public function it_manages_list_of_users_with_building_reference()
124 | {
125 | $collection = UserBuildingList::generateCollectionName(
126 | self::PRJ_VERSION,
127 | Projection::USER_BUILDING_LIST
128 | );
129 |
130 | $johnCheckedIn = $this->makeEvent(Event::USER_CHECKED_IN, [
131 | Payload::BUILDING_ID => self::BUILDING_ID,
132 | Payload::NAME => self::USERNAME1
133 | ]);
134 |
135 | $this->projector->handle(
136 | self::PRJ_VERSION,
137 | Projection::USER_BUILDING_LIST,
138 | $johnCheckedIn
139 | );
140 |
141 | $users = iterator_to_array($this->documentStore->findDocs(
142 | $collection,
143 | new AnyFilter()
144 | ));
145 |
146 | $this->assertEquals($users, [
147 | 'John' => ['buildingId' => self::BUILDING_ID]
148 | ]);
149 |
150 | $janeCheckedIn = $this->makeEvent(Event::USER_CHECKED_IN, [
151 | Payload::BUILDING_ID => self::BUILDING_ID,
152 | Payload::NAME => self::USERNAME2
153 | ]);
154 |
155 | $this->projector->handle(
156 | self::PRJ_VERSION,
157 | Projection::USER_BUILDING_LIST,
158 | $janeCheckedIn
159 | );
160 |
161 | $users = iterator_to_array($this->documentStore->findDocs(
162 | $collection,
163 | new AnyFilter()
164 | ));
165 |
166 | $this->assertEquals($users, [
167 | 'John' => ['buildingId' => self::BUILDING_ID],
168 | 'Jane' => ['buildingId' => self::BUILDING_ID],
169 | ]);
170 |
171 | $johnCheckedOut = $this->makeEvent(Event::USER_CHECKED_OUT, [
172 | Payload::BUILDING_ID => self::BUILDING_ID,
173 | Payload::NAME => self::USERNAME1
174 | ]);
175 |
176 | $this->projector->handle(
177 | self::PRJ_VERSION,
178 | Projection::USER_BUILDING_LIST,
179 | $johnCheckedOut
180 | );
181 |
182 | $users = iterator_to_array($this->documentStore->findDocs(
183 | $collection,
184 | new AnyFilter()
185 | ));
186 |
187 | $this->assertEquals($users, [
188 | 'Jane' => ['buildingId' => self::BUILDING_ID],
189 | ]);
190 | }
191 | }
192 |
193 | ```
194 |
195 | ## Testing Resolvers
196 |
197 | Resolvers can be tested in the same manner as projectors, using the `InMemoryDocumentStore` with test data.
198 | I will leave implementing these tests as an exercise for you ;)
199 |
200 | ## Integration Tests
201 |
202 | If you want to test the "whole thing" then you can extend your test class from `IntegrationTestCase`. It sets up Event Engine
203 | with an `InMemoryEventStore` and an `InMemoryDocumentStore`. A special PSR-11 MockContainer ensures that all other services are mocked.
204 | Let's see it in action. The annotated integration test should be self explanatory.
205 |
206 | *tests/Integration/NotifySecurityTest.php*
207 | ```php
208 | uiExchange = new class implements UiExchange {
234 |
235 | private $lastReceivedMessage;
236 |
237 | public function __invoke(Message $event): void
238 | {
239 | $this->lastReceivedMessage = $event;
240 | }
241 |
242 | public function lastReceivedMessage(): Message
243 | {
244 | return $this->lastReceivedMessage;
245 | }
246 | };
247 |
248 | // Mocks are passed to EE set up method
249 | // The IntegrationTestCase loads all EE descriptions
250 | // and uses the configured Flavour (PrototypingFlavour in our case)
251 | // to set up Event Engine
252 | $this->setUpEventEngine([
253 | UiExchange::class => $this->uiExchange,
254 | ]);
255 |
256 | /**
257 | * We can pass fixtures to the database set up:
258 | *
259 | * Stream to events map:
260 | *
261 | * [streamName => Event[]]
262 | *
263 | * Collection to documents map:
264 | *
265 | * [collectionName => [docId => doc]]
266 | */
267 | $this->setUpDatabase([
268 | // We use the default write model stream in the buildings app
269 | // and add a history for the test building
270 | // aggregate state is derived from history automatically during set up
271 | $this->eventEngine->writeModelStreamName() => [
272 | $this->makeEvent(Event::BUILDING_ADDED, [
273 | Payload::BUILDING_ID => self::BUILDING_ID,
274 | Payload::NAME => self::BUILDING_NAME
275 | ]),
276 | $this->makeEvent(Event::USER_CHECKED_IN, [
277 | Payload::BUILDING_ID => self::BUILDING_ID,
278 | Payload::NAME => self::USERNAME
279 | ]),
280 | ]
281 | ]);
282 | }
283 |
284 | /**
285 | * @test
286 | */
287 | public function it_detects_double_check_in_and_notifies_security()
288 | {
289 | //Try to check in John twice
290 | $checkInJohn = $this->makeCommand(Command::CHECK_IN_USER, [
291 | Payload::BUILDING_ID => self::BUILDING_ID,
292 | Payload::NAME => self::USERNAME
293 | ]);
294 |
295 | $this->eventEngine->dispatch($checkInJohn);
296 |
297 | //The IntegrationTestCase sets up an in-memory queue (accessible by $this->eventQueue)
298 | //You can inspect published events or simply process the queue
299 | //so that event listeners get invoked like our mocked UiExchange listener
300 | $this->processEventQueueWhileNotEmpty();
301 |
302 | //Now $this->lastPublishedEvent should point to the event received by UiExchange mock
303 | $this->assertNotNull($this->uiExchange->lastReceivedMessage());
304 |
305 | $this->assertEquals(Event::DOUBLE_CHECK_IN_DETECTED, $this->uiExchange->lastReceivedMessage()->messageName());
306 |
307 | $this->assertEquals([
308 | Payload::BUILDING_ID => self::BUILDING_ID,
309 | Payload::NAME => self::USERNAME
310 | ], $this->uiExchange->lastReceivedMessage()->payload());
311 | }
312 | }
313 |
314 | ```
315 | {.alert .alert-success}
316 | With a solid test suite in place, we can safely start refactoring our code towards a rich domain model. The next bonus part
317 | introduces stricter types for state and messages.
318 |
319 |
--------------------------------------------------------------------------------
/docs/tutorial/bookdown.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Tutorial",
3 | "content": [
4 | {"intro": "intro.md"},
5 | {"partI": "part_I.md"},
6 | {"partII": "part_II.md"},
7 | {"partIII": "part_III.md"},
8 | {"partIV": "part_IV.md"},
9 | {"partV": "part_V.md"},
10 | {"partVI": "part_VI.md"},
11 | {"partVII": "part_VII.md"},
12 | {"bonusI": "bonus_I.md"},
13 | {"bonusII": "bonus_II.md"},
14 | {"bonusIII": "bonus_III.md"},
15 | {"bonusIV": "bonus_IV.md"}
16 | ],
17 | "tocDepth": 1,
18 | "numbering": false
19 | }
20 |
--------------------------------------------------------------------------------
/docs/tutorial/img/Time_Travel.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/Time_Travel.gif
--------------------------------------------------------------------------------
/docs/tutorial/img/double_check_in_detected.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/double_check_in_detected.png
--------------------------------------------------------------------------------
/docs/tutorial/img/double_check_out_detected.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/double_check_out_detected.png
--------------------------------------------------------------------------------
/docs/tutorial/img/inspect_aggregate.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/inspect_aggregate.gif
--------------------------------------------------------------------------------
/docs/tutorial/img/inspectio_buildings_intro.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/inspectio_buildings_intro.png
--------------------------------------------------------------------------------
/docs/tutorial/img/monitoring.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/monitoring.png
--------------------------------------------------------------------------------
/docs/tutorial/img/notify_security.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/event-engine/docs/d14cc8422cf4c9bdbcb581a645a9eff94b7ce759/docs/tutorial/img/notify_security.png
--------------------------------------------------------------------------------
/docs/tutorial/intro.md:
--------------------------------------------------------------------------------
1 | # Introduction
2 |
3 | Event Engine is a rapid application development (RAD) framework. The basic concepts will be explained throughout the tutorial.
4 | Once finished, you should be able to start with your own project. The API docs will help you along the way.
5 |
6 | ## Tutorial Domain
7 |
8 | We're going to build a backend for a small web application where you can register `buildings` and then `check in` and `check out`
9 | users in the buildings. The backend will expose a messagebox endpoint that excepts commands and queries.
10 | Each time a user is `checked in` or `checked out` we get a notification via a websocket connection.
11 |
12 | 
13 |
14 | {.alert .alert-info}
15 | The screenshot is taken from [InspectIO](https://github.com/event-engine/inspectio){: class="alert-link"} - a domain modelling tool for (remote) teams that supports living documentation.
16 | Event Engine users can request free access in the chat.
17 |
18 | {.alert .alert-light}
19 | *Credits: The tutorial domain is the same as the one used by Marco Pivetta in his CQRS and Event Sourcing Workshops.*
20 |
21 | ## Application set up
22 |
23 | Please make sure you have [Docker](https://docs.docker.com/engine/installation/ "Install Docker") and [Docker Compose](https://docs.docker.com/compose/install/ "Install Docker Compose") installed.
24 |
25 | {.alert .alert-warning}
26 | *Note: Docker is THE ONLY supported set up at the moment. If you don't want to install docker you need PHP 7.4+ and Postgres 9.4+.*
27 |
28 | ### Clone Event Engine Skeleton
29 |
30 | Change into your working directory and use `composer` to create a new project based on the [event engine skeleton](https://github.com/event-engine/php-engine-skeleton)
31 | using `ee-buildings` as project name.
32 |
33 | ```bash
34 | $ docker run --rm -it -v $(pwd):/app prooph/composer:7.4 create-project event-engine/php-engine-skeleton ee-buildings
35 | ```
36 |
37 | Change into the newly created project dir `ee-buildings`, start the docker containers and run the set up script
38 | for the event store.
39 |
40 | ```bash
41 | $ cd ee-buildings
42 | $ sudo chown -R $(id -u -n):$(id -g -n) .
43 | $ docker-compose up -d
44 | $ docker-compose run php php scripts/create_event_stream.php
45 | ```
46 | The last command should output `done.` otherwise it will throw an exception.
47 |
48 | ### Verify set up
49 |
50 | #### Database
51 | Verify database set up by connecting to the Postgres database using:
52 |
53 | ```
54 | host: localhost
55 | port: 5432
56 | dbname: event_engine
57 | user: postgres
58 | pwd: dev
59 | ```
60 |
61 | {.alert .alert-info}
62 | *Note: Credentials are defined in `app.env` and can be changed there.*
63 |
64 | You should see three tables: `event_streams`, `projections` and `_
3 |
11 |
4 |
10 | Event Engine
5 |The world's only CQRS / ES framework that lets you pick your Flavour
6 |
7 | $ composer create-project event-engine/php-engine-skeleton event-engine
8 |
9 |
12 |
20 |
13 |
19 | 14 | Event Engine is a CQRS / EventSourcing framework for PHP to help you rapidly develop 15 | event sourced applications, while providing a path to 16 | refactor towards a richer domain model as needed. Customize Event Engine with Flavours. Choose between different programming styles. 17 |
18 |Choose Your Flavour
21 |
22 |
51 |
23 |
29 |
24 |
28 |
25 | PROTOTYPING
26 |
27 | PROTOTYPING
rapid development, maximized developer happiness
26 |
30 |
36 |
31 |
35 |
32 | FUNCTIONAL
33 |
34 | FUNCTIONAL
stateless and pure, with a funcional core
33 |
37 |
43 |
38 |
42 |
39 | OOP
40 |
41 | OOP
event sourced objects without dependencies
40 |
44 |
50 |
45 |
49 |
46 | MIXED
47 |
48 | MIXED
create your very own Flavour
47 | CQRS By Design
52 |
53 |
59 |
54 |
58 | 55 | Built-in PSR-7 Messagebox with JSON Schema and Event Engine Cockpit support. Focus on the domain model. Let Event Engine handle the rest. 56 |
57 |
60 |
64 |
61 | 
62 |
63 |
62 | Event Sourcing Engine
65 |
66 |
72 |
67 |
71 | 68 | Straightforward Event Sourcing without boilerplate. Rapid. Effective. Simple. 69 |
70 |
73 |
77 |
74 | 
75 |
76 |
75 | Tutorial
78 |
79 |
85 |
80 |
84 | 81 | Learn CQRS / EventSourcing basics with Event Engine in a step by step tutorial. 82 |
83 |
86 |
90 |
87 | 
88 |
89 |
88 | 91 |
92 |
93 |
94 |
98 |
95 | Get Started
96 |
97 | 99 |
100 |
104 |
101 | Imprint | Powered by Bookdown Bootswatch Templates.
102 |
103 |
14 | render('core'); ?>
15 |
16 | forkOnGithub(); ?>
17 | render('script'); ?>
18 |
19 |
--------------------------------------------------------------------------------
/template/head.php:
--------------------------------------------------------------------------------
1 |
5 | *
6 | * For the full copyright and license information, please view the LICENSE
7 | * file that was distributed with this source code.
8 | */
9 | ?>
10 |
11 | render('meta'); ?>
12 | render('style'); ?>
13 | render('styleProoph'); ?>
14 |
15 |
--------------------------------------------------------------------------------
/template/helper/forkOnGithub.php:
--------------------------------------------------------------------------------
1 | isRemote()) {
10 | $this->githubRepo = $this->extractGithubRepo($config);
11 | }
12 | }
13 |
14 | public function __invoke()
15 | {
16 | return 'Fork me on GitHub';
17 | }
18 |
19 | private function extractGithubRepo(\Bookdown\Bookdown\Config\IndexConfig $config)
20 | {
21 | $match = [];
22 | if(preg_match('/^https:\/\/raw.githubusercontent.com\/(?P
27 |
28 |
29 |
30 |
31 | render("partialSideNav"); ?>
32 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/template/partial/sideNav.php:
--------------------------------------------------------------------------------
1 | page instanceof \Bookdown\Bookdown\Content\IndexPage) {
13 | return '';
14 | }
15 | $startLevel = 0;
16 | ?>
17 |
48 |
--------------------------------------------------------------------------------
/template/partial/topNav.php:
--------------------------------------------------------------------------------
1 |
16 |
17 |
18 | anchorRaw($page->getHref(), $page->getTitle()); ?>
19 |
20 |
21 | getChildren()) > 0
23 | && $depth <= $maxDepth
24 | ): ?>
25 |
26 |
27 |
40 |
41 |
--------------------------------------------------------------------------------
/template/style.php:
--------------------------------------------------------------------------------
1 |
5 | *
6 | * For the full copyright and license information, please view the LICENSE
7 | * file that was distributed with this source code.
8 | */
9 | ?>
10 |
334 |
--------------------------------------------------------------------------------
/template/toc.php:
--------------------------------------------------------------------------------
1 | page->hasNestedTocEntries()) {
11 | return;
12 | }
13 |
14 | ?>
15 |
16 |
-
28 | getChildren() as $child) : ?>
29 | render('partialTopNav', array(
30 | 'page' => $child,
31 | 'depth' => $depth
32 | ));
33 | ?>
34 |
35 |