Merge pull request #18 from Bl00D4NGEL/enhance-generic-support

Improve type definitions
geekcell · Nov 29, 2023 · 8e000ea · 8e000ea
2 parents 9023c1d + c6a9b92
commit 8e000ea
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 18 deletions.
diff --git a/src/Contracts/Domain/Paginator.php b/src/Contracts/Domain/Paginator.php
@@ -4,10 +4,11 @@
 
 namespace GeekCell\Ddd\Contracts\Domain;
 
-use Countable;
-use IteratorAggregate;
-
-interface Paginator extends Countable, IteratorAggregate
+/**
+ * @template T of object
+ * @extends \IteratorAggregate<T>
+ */
+interface Paginator extends \Countable, \IteratorAggregate
 {
     /**
      * Returns the current page.

diff --git a/src/Contracts/Domain/Repository.php b/src/Contracts/Domain/Repository.php
@@ -4,16 +4,18 @@
 
 namespace GeekCell\Ddd\Contracts\Domain;
 
-use Countable;
 use GeekCell\Ddd\Domain\Collection;
-use IteratorAggregate;
 
-interface Repository extends Countable, IteratorAggregate
+/**
+ * @template T of object
+ * @extends \IteratorAggregate<T>
+ */
+interface Repository extends \Countable, \IteratorAggregate
 {
     /**
      * Returns a collection of items.
      *
-     * @return Collection
+     * @return Collection<T>
      */
     public function collect(): Collection;
 
@@ -23,7 +25,7 @@ public function collect(): Collection;
      * @param int $itemsPerPage
      * @param int $currentPage
      *
-     * @return Paginator
+     * @return Paginator<T>
      */
     public function paginate(
         int $itemsPerPage,

diff --git a/src/Domain/Collection.php b/src/Domain/Collection.php
@@ -6,14 +6,15 @@
 
 use Assert;
 
+/**
+ * @template T of object
+ * @extends \IteratorAggregate<T>
+ */
 class Collection implements \ArrayAccess, \Countable, \IteratorAggregate
 {
     /**
-     * @template T of object
-     * @extends \IteratorAggregate<T>
-     *
      * @param T[] $items
-     * @param class-string<T> $itemType
+     * @param class-string<T>|null $itemType
      *
      * @throws Assert\AssertionFailedException
      */

diff --git a/src/Domain/ValueObject/Id.php b/src/Domain/ValueObject/Id.php
@@ -29,7 +29,7 @@ final public function __construct(int $id)
     /**
      * @inheritDoc
      */
-    public function getValue(): mixed
+    public function getValue(): int
     {
         return $this->id;
     }

diff --git a/src/Domain/ValueObject/Uuid.php b/src/Domain/ValueObject/Uuid.php
@@ -55,7 +55,7 @@ public function equals(ValueObjectInterface $object): bool
     /**
      * @inheritDoc
      */
-    public function getValue(): mixed
+    public function getValue(): string
     {
         return $this->uuid;
     }

diff --git a/src/Infrastructure/InMemory/Paginator.php b/src/Infrastructure/InMemory/Paginator.php
@@ -11,8 +11,17 @@
 use LimitIterator;
 use Traversable;
 
+/**
+ * @template T of object
+ * @extends PaginatorInterface<T>
+ */
 class Paginator implements PaginatorInterface, ArrayAccess
 {
+    /**
+     * @param Collection<T> $collection
+     * @param int $itemsPerPage
+     * @param int $currentPage
+     */
     public function __construct(
         private readonly Collection $collection,
         private int $itemsPerPage,

diff --git a/src/Infrastructure/InMemory/Repository.php b/src/Infrastructure/InMemory/Repository.php
@@ -11,6 +11,10 @@
 use GeekCell\Ddd\Infrastructure\InMemory\Paginator as InMemoryPaginator;
 use Traversable;
 
+/**
+ * @template T of object
+ * @extends RepositoryInterface<T>
+ */
 abstract class Repository implements RepositoryInterface
 {
     /**
@@ -19,9 +23,6 @@ abstract class Repository implements RepositoryInterface
     protected array $items = [];
 
     /**
-     * @template T of object
-     * @extends IteratorAggregate<T>
-     *
      * @param class-string<T> $itemType
      */
     public function __construct(