Merge pull request #18 from yemilgr/returns-type-hints

add more missing return type hints && tag it 1.4.1
drupol · May 15, 2024 · d1e9f98 · d1e9f98
2 parents 00a3d1d + b326e9f
commit d1e9f98
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 40 deletions.
diff --git a/src/Iterators.php b/src/Iterators.php
@@ -23,15 +23,15 @@ abstract class Iterators extends Combinatorics implements Countable, IteratorInt
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         return $this->current;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function key()
+    public function key(): int
     {
         return $this->key;
     }
@@ -41,7 +41,7 @@ public function key()
      *
      * @return void
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->key = 0;
     }

diff --git a/src/Iterators/Combinations.php b/src/Iterators/Combinations.php
@@ -46,7 +46,7 @@ public function count(): int
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         $r = [];
 
@@ -74,7 +74,7 @@ public function next(): void
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->c = range(0, $this->length);
         $this->key = 0;

diff --git a/src/Iterators/Cycle.php b/src/Iterators/Cycle.php
@@ -21,7 +21,7 @@ public function count(): int
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         return $this->dataset[$this->key];
     }
@@ -39,7 +39,7 @@ public function next()
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->key = 0;
     }

diff --git a/src/Iterators/Fibonacci.php b/src/Iterators/Fibonacci.php
@@ -54,7 +54,7 @@ public function getMaxLimit(): int
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         [$this->current, $this->previous] = [$this->current + $this->previous, $this->current];
         ++$this->key;
@@ -63,7 +63,7 @@ public function next()
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->previous = 1;
         $this->current = 0;
@@ -78,7 +78,7 @@ public function rewind()
      *
      * @return void
      */
-    public function setMaxLimit($max)
+    public function setMaxLimit($max): void
     {
         $this->max = $max;
     }

diff --git a/src/Iterators/FiniteGroup.php b/src/Iterators/FiniteGroup.php
@@ -43,7 +43,7 @@ public function count(): int
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         return current($this->group);
     }
@@ -64,7 +64,7 @@ public function getSize(): int
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         ++$this->key;
         next($this->group);
@@ -99,7 +99,7 @@ public function order($generator): int
      *
      * @return void
      */
-    public function setSize($size)
+    public function setSize($size): void
     {
         $this->size = $size;
         $this->computeGroup();
@@ -120,7 +120,7 @@ public function valid(): bool
      *
      * @return void
      */
-    private function computeGroup()
+    private function computeGroup(): void
     {
         $this->group = [];
 

diff --git a/src/Iterators/NGrams.php b/src/Iterators/NGrams.php
@@ -35,7 +35,7 @@ public function __construct(array $dataset = [], $length = 1)
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         return $this->currentValue;
     }
@@ -45,7 +45,7 @@ public function current()
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         parent::next();
         $this->currentValue = array_slice($this->current, 0, $this->getLength());
@@ -56,7 +56,7 @@ public function next()
      *
      * @return void
      */
-    public function rewind()
+    public function rewind(): void
     {
         parent::rewind();
         $this->currentValue = array_slice($this->current, 0, $this->getLength());

diff --git a/src/Iterators/Perfect.php b/src/Iterators/Perfect.php
@@ -37,7 +37,7 @@ public function __construct()
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         for ($i = $this->key(); $this->getMaxLimit() > $i; ++$i) {
             if ($this->isPerfectNumber($i)) {
@@ -77,15 +77,15 @@ public function getMinLimit(): int
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         ++$this->key;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->key = $this->getMinLimit();
     }
@@ -98,7 +98,7 @@ public function rewind()
      *
      * @return void
      */
-    public function setMaxLimit($max)
+    public function setMaxLimit($max): void
     {
         $this->max = $max;
     }
@@ -111,7 +111,7 @@ public function setMaxLimit($max)
      *
      * @return void
      */
-    public function setMinLimit($min)
+    public function setMinLimit($min): void
     {
         $this->min = $min;
     }

diff --git a/src/Iterators/Prime.php b/src/Iterators/Prime.php
@@ -37,7 +37,7 @@ public function __construct()
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         for ($i = $this->key(); $this->getMaxLimit() > $i; ++$i) {
             if ($this->isPrimeNumber($i)) {
@@ -77,15 +77,15 @@ public function getMinLimit(): int
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         ++$this->key;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->key = $this->getMinLimit();
     }
@@ -98,7 +98,7 @@ public function rewind()
      *
      * @return void
      */
-    public function setMaxLimit($max)
+    public function setMaxLimit($max): void
     {
         $this->max = $max;
     }
@@ -111,7 +111,7 @@ public function setMaxLimit($max)
      *
      * @return void
      */
-    public function setMinLimit($min)
+    public function setMinLimit($min): void
     {
         $this->min = $min;
     }

diff --git a/src/Iterators/PrimeFactors.php b/src/Iterators/PrimeFactors.php
@@ -38,7 +38,7 @@ public function count(): int
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         return current($this->factors);
     }
@@ -59,7 +59,7 @@ public function getNumber(): int
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         ++$this->key;
         next($this->factors);
@@ -68,7 +68,7 @@ public function next()
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->key = 0;
     }
@@ -81,7 +81,7 @@ public function rewind()
      *
      * @return void
      */
-    public function setNumber($number)
+    public function setNumber($number): void
     {
         $this->number = $number;
         $this->factors = $this->getFactors($this->getNumber());

diff --git a/src/Iterators/Product.php b/src/Iterators/Product.php
@@ -53,7 +53,7 @@ public function count(): int
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         $tuple = [];
 
@@ -69,7 +69,7 @@ public function current()
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         foreach (array_reverse($this->iterators) as $key => $iterator) {
             $iterator->next();
@@ -95,7 +95,7 @@ public function next()
      *
      * @return void
      */
-    public function rewind()
+    public function rewind(): void
     {
         foreach ($this->iterators as $iterator) {
             $iterator->rewind();

diff --git a/src/Iterators/Rotation.php b/src/Iterators/Rotation.php
@@ -41,7 +41,7 @@ public function count(): int
     /**
      * {@inheritdoc}
      */
-    public function current()
+    public function current(): mixed
     {
         return $this->rotation;
     }
@@ -54,7 +54,7 @@ public function current()
      *
      * @return void
      */
-    public function next($offset = 1)
+    public function next($offset = 1): void
     {
         $offset = (null === $offset) ? 1 : $offset % $this->count();
         $this->rotation = array_merge(
@@ -73,7 +73,7 @@ public function next($offset = 1)
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->rotation = $this->getDataset();
     }

diff --git a/src/Iterators/Shift.php b/src/Iterators/Shift.php
@@ -38,15 +38,15 @@ public function count(): int
      *
      * @return void
      */
-    public function next()
+    public function next(): void
     {
         $this->doShift(1);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->doShift(-1);
     }
@@ -68,7 +68,7 @@ public function valid(): bool
      *
      * @return void
      */
-    protected function doShift($length = 1)
+    protected function doShift($length = 1): void
     {
         $parameters = [];