Merge pull request #31 from spaceemotion/add-aggregate-root-typehints

Provide docblocks to AggregateRoot class
spatie · Oct 31, 2019 · ffa017f · ffa017f
2 parents 293aac9 + 6af090e
commit ffa017f
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/AggregateRoot.php b/src/AggregateRoot.php
@@ -13,6 +13,10 @@ abstract class AggregateRoot
     /** @var array */
     private $recordedEvents = [];
 
+    /**
+     * @param  string  $uuid
+     * @return static
+     */
     public static function retrieve(string $uuid): AggregateRoot
     {
         $aggregateRoot = (new static());
@@ -22,6 +26,10 @@ public static function retrieve(string $uuid): AggregateRoot
         return $aggregateRoot->reconstituteFromEvents();
     }
 
+    /**
+     * @param  ShouldBeStored  $domainEvent
+     * @return static
+     */
     public function recordThat(ShouldBeStored $domainEvent): AggregateRoot
     {
         $this->recordedEvents[] = $domainEvent;
@@ -31,6 +39,9 @@ public function recordThat(ShouldBeStored $domainEvent): AggregateRoot
         return $this;
     }
 
+    /**
+     * @return static
+     */
     public function persist(): AggregateRoot
     {
         $storedEvents = call_user_func(