From 44db1098ba710edfb9813b508a321e3210365d47 Mon Sep 17 00:00:00 2001 From: Julien Mercier-Rojas Date: Mon, 3 Jan 2022 16:23:55 +0100 Subject: [PATCH] Update doc --- README.md | 36 ------------------------------------ 1 file changed, 36 deletions(-) diff --git a/README.md b/README.md index b0e44a6..c1bf415 100644 --- a/README.md +++ b/README.md @@ -205,39 +205,3 @@ In each layer, when we need to throw an Exception, we create a new class corresp - extends one of the [SPL exception](https://www.php.net/manual/en/spl.exceptions.php) or another (more generic) exception from the same namespace. - implements the exception interface of the current layer. - - -## Old Documentation - -### Core - -- **[CommandDispatcher](src/Core/CommandDispatcher/)**: Define all contract for the **command bus** implementation with - - **[Command](src/Core/CommandDispatcher/Command/Command.php)** - - **[CommandHandler](src/Core/CommandDispatcher/CommandHandler/CommandHandler.php)** - - **[CommandResponse](src/Core/CommandDispatcher/CommandResponse/CommandResponse.php)** - -### Domain - - - -- **[Dto](src/Domain/Dto/Dto.php)**: main **Dto** contract (empty for now, used to define typings) -- **[Entity](src/Domain/Entity/Entity.php)**: main **Entity** contract (empty for now, used to define typings) - - **[DomainEventAwareInterface](src/Domain/Entity/DomainEventAwareInterface.php)**: Define how entities handle Events, and for `Event` type ([Trait](src/Domain/Entity/DomainEventAwareTrait.php) also available) -- **[Event](src/Domain/Event/Event.php)**: **Event** contract, force immutability, used by `CommandResponse`, `Entity` (EventAware) and `CommandBus` -- **[Exception](src/Domain/Exception/)**: Define a collection of Domain exceptions, all immutable -- **[Identity](src/Domain/Identity/Identity.php)**: Main contract for entity's **Identities** with exceptions, forced immutability and `Equality` interface -- **[ValueObject](src/Domain/ValueObject/ValueObject.php)**: force immutability on ValueObject, implements `toScalar` and `__toString` methods. See [psalm templating](https://psalm.dev/docs/annotating_code/templated_annotations/) documentation for more info. -- **[Equality](src/Domain/Equality.php)**: define `equal` method, required for Identity, but can be also use for entities and value objects. - -### Infrastructure -- **[Exception](src/Infrastructure/Exception/)**: Define basics Infrastructure exceptions (with forced immutability) -- **[Clock](src/Infrastructure/System/Clock.php)**: Define clock contract to return the current time as a mockable service - -### Presentation -- **[Exception](src/Presentation/Exception/)**: Define basics Presentation exceptions (with forced immutability) - -## Resources - -Please also read some Psalm documentation: - - [psalm template](https://psalm.dev/docs/annotating_code/templated_annotations/) - - [psalm immutable](https://psalm.dev/articles/immutability-and-beyond)