Merge pull request #69 from simPod/templating

Add templating annotations

Author: rtheunissen

composer.json

@@ -9,7 +9,7 @@
         }
     ],
     "require": {
-        "php": ">=7.0.0",
+        "php": ">=7.1.0",
         "ext-json": "*"
     },
     "require-dev": {

src/Collection.php

@@ -7,6 +7,10 @@
  * traversable, countable, and can be converted to json using json_encode().
  *
  * @package Ds
+ *
+ * @template-covariant TKey
+ * @template-covariant TValue
+ * @extends Traversable<TKey, TValue>
  */
 interface Collection extends \IteratorAggregate, \Countable, \JsonSerializable
 {
@@ -26,6 +30,8 @@ function count(): int;
      * Returns a shallow copy of the collection.
      *
      * @return static a copy of the collection.
+     *
+     * @psalm-return static<TKey, TValue>
      */
     function copy();
 
@@ -34,8 +40,6 @@ function copy();
      *
      * This should be equivalent to a count of zero, but is not required.
      * Implementations should define what empty means in their own context.
-     *
-     * @return bool
      */
     function isEmpty(): bool;
 
@@ -46,7 +50,7 @@ function isEmpty(): bool;
      * Some implementations may throw an exception if an array representation
      * could not be created.
      *
-     * @return array
+     * @return array<TKey, TValue>
      */
     function toArray(): array;
 }

src/Deque.php

@@ -10,6 +10,9 @@
  * at both ends of the buffer, ie. shift, unshift, push and pop are all O(1).
  *
  * @package Ds
+ *
+ * @template TValue
+ * @implements Sequence<TValue>
  */
 final class Deque implements Sequence
 {

src/Hashable.php

@@ -26,9 +26,7 @@ function hash();
      * Determines if two objects should be considered equal. Both objects will
      * be instances of the same class but may not be the same instance.
      *
-     * @param $obj An instance of the same class to compare to.
-     *
-     * @return bool
+     * @param mixed $obj An instance of the same class to compare to.
      */
     function equals($obj): bool;
 }