Merge pull request #43 from YevicT/add-annotation-template-collection

🧑‍💻 Add template annotation to Collections

Author: lennyrouanet

component/Abstract/Collection.php

@@ -4,14 +4,24 @@
 
 namespace Phant\DataStructure\Abstract;
 
+/**
+ * @template T
+ */
 abstract class Collection
 {
+    /**
+     * @var array<T>
+     */
     protected array $items = [];
 
     public function __construct(
     ) {
     }
 
+    /**
+     * @param T $item
+     * @return static
+     */
     protected function addItem(
         mixed $item
     ): static {
@@ -22,6 +32,10 @@ protected function addItem(
         return $this;
     }
 
+    /**
+     * @param T $item
+     * @return static
+     */
     protected function removeItem(
         mixed $item
     ): static {
@@ -33,12 +47,18 @@ protected function removeItem(
         return $this;
     }
 
+    /**
+     * @param T $item
+     */
     final public function contains(
         mixed $item
     ): bool {
         return array_search($item, $this->items) !== false;
     }
 
+    /**
+     * @return \Generator<T>
+     */
     final public function iterate(
     ): \Generator {
         foreach ($this->items as $item) {
@@ -56,12 +76,19 @@ final public function getNbItems(
         return count($this->items);
     }
 
+    /**
+     * @return T|null
+     */
     final public function getByKey(
         int $key
     ): mixed {
         return $this->items[ $key ] ?? null;
     }
 
+    /**
+     * @param Collection<T> $collection
+     * @return static
+     */
     final public function merge(
         self $collection
     ): static {
@@ -72,6 +99,11 @@ final public function merge(
         return $this;
     }
 
+    /**
+     * @template U
+     * @param callable(T): U $callback
+     * @return array<U>
+     */
     final public function map(
         callable $callback
     ): array {

test/Abstract/CollectionTest.php

@@ -76,7 +76,7 @@ public function testMap(): void
         $collection->add($value1);
         $collection->add($value2);
 
-        $result = $collection->map(fn(Value $item) => (string)$item . '!');
+        $result = $collection->map(fn (Value $item) => (string)$item . '!');
 
         $this->assertIsArray($result);
         $this->assertCount(2, $result);