add identifier

Author: DavidBadura

docs/mkdocs.yml

@@ -101,7 +101,7 @@ nav:
     - Event Bus:  event_bus.md
     - Query Bus:  query_bus.md
   - Advanced:
-    - Aggregate ID: aggregate_id.md
+    - Identifier: identifier.md
     - Normalizer: normalizer.md
     - Snapshots: snapshots.md
     - Personal Data: personal_data.md

docs/pages/UPGRADE-4.0.md

@@ -61,7 +61,6 @@ $subscriptionEngine = new DefaultSubscriptionEngine(
     RetryStrategyRepository::withDefault($retryStrategy),
 );
 ```
-
 ## Store
 
 ### DoctrineDbalStore
@@ -95,4 +94,4 @@ and replaced with the following headers:
 ### DoctrineSchemaSubscriber
 
 The `Patchlevel\EventSourcing\Schema\DoctrineSchemaSubscriber` has been removed.
-use the `Patchlevel\EventSourcing\Schema\DoctrineSchemaListener` instead.
+use the `Patchlevel\EventSourcing\Schema\DoctrineSchemaListener` instead.

docs/pages/aggregate.md

@@ -24,9 +24,9 @@ To make it easy to register with a name, we also add the `Aggregate` attribute.
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -50,7 +50,7 @@ final class Profile extends BasicAggregateRoot
 
 !!! tip
 
-    Find out more about aggregate IDs [here](./aggregate_id.md).
+    Find out more about aggregate IDs [here](./identifier.md).
 
 We use a so-called named constructor here to create an object of the AggregateRoot.
 The constructor itself is protected and cannot be called from outside.
@@ -94,8 +94,8 @@ For our aggregate we create the Event `ProfileRegistered` with an ID and a name.
 We also give the event a unique name using the `Event` attribute.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Event;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Event('profile.registered')]
 final class ProfileRegistered
@@ -115,10 +115,10 @@ After we have defined the event, we have to adapt the profile aggregate:
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -190,10 +190,10 @@ This method then creates the event `NameChanged` and records it:
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -466,10 +466,10 @@ We can now use the value object `Name` in our aggregate:
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -587,9 +587,9 @@ But you can pass this information by yourself.
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -614,9 +614,9 @@ But if you still want to make sure that the time is "now" and not in the past or
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Psr\Clock\ClockInterface;
 
 #[Aggregate('profile')]
@@ -663,10 +663,10 @@ The order handle the order itself and the shipping handle the shipping of the or
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('order')]
 final class Order extends BasicAggregateRoot
@@ -694,11 +694,11 @@ In this case, the `Shipping` aggregate listens to the `OrderCreated` event to in
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
 use Patchlevel\EventSourcing\Attribute\Stream;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('shipping')]
 #[Stream(Order::class)]
@@ -756,7 +756,7 @@ $aggregateRegistry = (new AttributeAggregateRootRegistryFactory())->create([/* p
 ```
 ## Learn more
 
-* [How to create own aggregate id](aggregate_id.md)
+* [How to create own aggregate id](identifier.md)
 * [How to store and load aggregates](repository.md)
 * [How to snapshot aggregates](snapshots.md)
 * [How to create Projections](subscription.md)

docs/pages/command_bus.md

@@ -362,5 +362,5 @@ $provider = new ChainHandlerProvider([
 * [How to use aggregates](aggregate.md)
 * [How to use events](events.md)
 * [How to use clock](clock.md)
-* [How to use aggregate id](aggregate_id.md)
+* [How to use aggregate id](identifier.md)
 * [How to use query bus](query_bus.md)

docs/pages/events.md

@@ -89,8 +89,8 @@ You can do that too. However, you must define a normalizer for this
 so that the library knows how to write this data to the database and load it again.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Event;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Serializer\Normalizer\IdNormalizer;
 use Patchlevel\Hydrator\Normalizer\DateTimeImmutableNormalizer;
 

docs/pages/getting_started.md

@@ -10,8 +10,8 @@ First we define the events that happen in our system.
 A hotel can be created with a `name` and a `id`:
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Event;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Event('hotel.created')]
 final class HotelCreated
@@ -69,10 +69,10 @@ Last but not least, we need the associated apply methods to change the state.
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Apply;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('hotel')]
 final class Hotel extends BasicAggregateRoot
@@ -163,6 +163,7 @@ use Patchlevel\EventSourcing\Attribute\Projector;
 use Patchlevel\EventSourcing\Attribute\Setup;
 use Patchlevel\EventSourcing\Attribute\Subscribe;
 use Patchlevel\EventSourcing\Attribute\Teardown;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Subscription\Subscriber\SubscriberUtil;
 
 #[Projector('hotel')]
@@ -373,7 +374,7 @@ $engine->setup(skipBooting: true);
 We are now ready to use the Event Sourcing System. We can load, change and save aggregates.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Repository\Repository;
 
 $hotel1 = Hotel::create(Uuid::generate(), 'HOTEL');
@@ -393,7 +394,7 @@ $hotels = $hotelProjection->getHotels();
 !!! note
 
     You can also use other forms of IDs such as uuid version 6 or a custom format. 
-    You can find more about this [here](aggregate_id.md).
+    You can find more about this [here](identifier.md).
 
 ## Result
 

docs/pages/aggregate_id.md docs/pages/identifier.mddocs/pages/aggregate_id.md renamed to docs/pages/identifier.md

@@ -1,4 +1,4 @@
-# Aggregate ID
+# Identifier
 
 The `aggregate id` is a unique identifier for an aggregate.
 It is used to identify the aggregate in the event store.
@@ -22,9 +22,9 @@ You can use it like this:
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\Uuid;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -36,7 +36,7 @@ final class Profile extends BasicAggregateRoot
 You have multiple options for generating an uuid:
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 
 $uuid = Uuid::generate();
 $uuid = Uuid::fromString('d6e8d7a0-4b0b-4e6a-8a9a-3a0b2d9d0e4e');
@@ -53,9 +53,9 @@ This is a value object that holds any string.
 
 ```php
 use Patchlevel\EventSourcing\Aggregate\BasicAggregateRoot;
-use Patchlevel\EventSourcing\Aggregate\CustomId;
 use Patchlevel\EventSourcing\Attribute\Aggregate;
 use Patchlevel\EventSourcing\Attribute\Id;
+use Patchlevel\EventSourcing\Identifier\CustomId;
 
 #[Aggregate('profile')]
 final class Profile extends BasicAggregateRoot
@@ -73,7 +73,7 @@ final class Profile extends BasicAggregateRoot
 So you can use any string as an id:
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\CustomId;
+use Patchlevel\EventSourcing\Identifier\CustomId;
 
 $id = CustomId::fromString('my-id');
 ```
@@ -84,9 +84,9 @@ This allows you to ensure that the correct id is always used.
 The whole thing looks like this:
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\AggregateRootId;
+use Patchlevel\EventSourcing\Identifier\Identifier;
 
-class ProfileId implements AggregateRootId
+class ProfileId implements Identifier
 {
     private function __construct(
         private readonly string $id,
@@ -98,7 +98,7 @@ class ProfileId implements AggregateRootId
         return $this->id;
     }
 
-    public static function fromString(string $id): self
+    public static function fromString(string $id): static
     {
         return new self($id);
     }
@@ -122,21 +122,21 @@ We also offer you some traits, so that you don't have to implement the `Aggregat
 Here for the uuid:
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\AggregateRootId;
-use Patchlevel\EventSourcing\Aggregate\RamseyUuidV7Behaviour;
+use Patchlevel\EventSourcing\Identifier\Identifier;
+use Patchlevel\EventSourcing\Identifier\RamseyUuidV7Behaviour;
 
-class ProfileId implements AggregateRootId
+class ProfileId implements Identifier
 {
     use RamseyUuidV7Behaviour;
 }
 ```
 Or for the custom id:
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\AggregateRootId;
-use Patchlevel\EventSourcing\Aggregate\CustomIdBehaviour;
+use Patchlevel\EventSourcing\Identifier\CustomIdBehaviour;
+use Patchlevel\EventSourcing\Identifier\Identifier;
 
-class ProfileId implements AggregateRootId
+class ProfileId implements Identifier
 {
     use CustomIdBehaviour;
 }

docs/pages/normalizer.md

@@ -275,7 +275,7 @@ final class DTO
 If you have your own AggregateRootId, you can use the `IdNormalizer`.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Serializer\Normalizer\IdNormalizer;
 
 final class DTO
@@ -291,7 +291,7 @@ final class DTO
 Optional you can also define the type of the id.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Serializer\Normalizer\IdNormalizer;
 
 final class DTO

docs/pages/personal_data.md

@@ -26,7 +26,7 @@ In order for the correct key to be used, a subject ID must be defined.
 Without Subject Id, no personal data can be encrypted or decrypted.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
 
 final class EmailChanged
@@ -48,7 +48,7 @@ final class EmailChanged
 Next, you have to mark the properties that should be encrypted with the `#[PersonalData]` attribute.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
 use Patchlevel\Hydrator\Attribute\PersonalData;
 

docs/pages/repository.md

@@ -154,7 +154,7 @@ All new events that have not yet been written to the database are fetched from t
 These events are then also append to the database.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Repository\Repository;
 
 $id = Uuid::generate();
@@ -187,7 +187,7 @@ An `aggregate` can be loaded using the `load` method.
 All events for the aggregate are loaded from the database and the current state is rebuilt.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Repository\Repository;
 
 $id = Uuid::fromString('229286ff-6f95-4df6-bc72-0a239fe7b284');
@@ -210,7 +210,7 @@ You can also check whether an `aggregate` with a certain id exists.
 It is checked whether any event with this id exists in the database.
 
 ```php
-use Patchlevel\EventSourcing\Aggregate\Uuid;
+use Patchlevel\EventSourcing\Identifier\Uuid;
 use Patchlevel\EventSourcing\Repository\Repository;
 
 $id = Uuid::fromString('229286ff-6f95-4df6-bc72-0a239fe7b284');