#18: added PHPStan hints

Author: MaxGoryunov

fakes/TimesCalled.php

@@ -2,12 +2,17 @@
 
 namespace MaxGoryunov\SavingIterator\Fakes;
 
+/**
+ * This class checks how many times a specified method was called.
+ * @template T
+ * @mixin T
+ */
 class TimesCalled
 {
     /**
      * Original object.
      * 
-     * @var object
+     * @var T
      */
     private object $origin;
 
@@ -28,9 +33,9 @@ class TimesCalled
     /**
      * Ctor.
      *
-     * @param object $origin
+     * @param T $origin
      */
-    public function __construct(object $origin, string $method)
+    public function __construct($origin, string $method)
     {
         $this->origin = $origin;
         $this->method = $method;
@@ -58,12 +63,6 @@ public function __call(string $name, array $arguments): mixed
         if ($name === $this->method) {
             $this->times++;
         }
-
-        if ($arguments === []) {
-            $result = $this->origin->$name();
-        } else {
-            $result = $this->origin->$name($arguments);
-        }
-        return $result;
+        return $this->origin->$name(...$arguments);
     }
 }

src/SavingIterator.php

@@ -4,26 +4,33 @@
 
 use Iterator;
 
+/**
+ * Iterator which stores iterated values.
+ * 
+ * @template TKey
+ * @template TValue
+ * @implements Iterator<TKey, TValue>
+ */
 class SavingIterator implements Iterator
 {
 
     /**
      * Original iterator
      * 
-     * @var Iterator
+     * @var Iterator<TKey, TValue>
      */
     private Iterator $origin;
 
     /**
      * Cached values from the inner iterator
      * 
-     * @var array
+     * @var array<TKey, TValue>
      */
     private array $saved = [];
     /**
      * Ctor.
      *
-     * @param Iterator $iterator
+     * @param Iterator<TKey, TValue> $iterator
      */
     public function __construct(Iterator $iterator)
     {
@@ -32,6 +39,7 @@ public function __construct(Iterator $iterator)
 
     /**
      * {@inheritDoc}
+     * @return TValue|false
      */
     public function current(): mixed
     {
@@ -43,6 +51,7 @@ public function current(): mixed
 
     /**
      * {@inheritDoc}
+     * @return TKey|null
      */
     public function key(): mixed
     {

tests/fakes/TimesCalledTest.php

@@ -49,6 +49,7 @@ public function testCountsHowManyTimesTheMethodWasCalled(): void
     public function testCountsHowManyTimesTheMethodWasCalledAlongWIthOtherMethods(): void
     {
         $method = "key";
+        $other  = "current";
         $called = new TimesCalled(
             new ArrayIterator([16, 14, 13, 15, 12, 18]),
             $method
@@ -59,7 +60,7 @@ public function testCountsHowManyTimesTheMethodWasCalledAlongWIthOtherMethods():
             $called->$method();
 
             if (($i % 2 === 0) or ($i % 3 === 0)) {
-                $called->current();
+                $called->$other();
             }
         }