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

drupol · web-flow · commit d1e9f983c045 · 2024-05-15T09:01:01.000+02:00
add more missing return type hints &amp;&amp; tag it 1.4.1
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 = [];
 

Original file line number	Diff line number	Diff line change
`@@ -23,15 +23,15 @@ abstract class Iterators extends Combinatorics implements Countable, IteratorInt`
`23`	`23`	`/**`
`24`	`24`	`* {@inheritdoc}`
`25`	`25`	`*/`
`26`		`- public function current()`
	`26`	`+ public function current(): mixed`
`27`	`27`	`{`
`28`	`28`	`return $this->current;`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/**`
`32`	`32`	`* {@inheritdoc}`
`33`	`33`	`*/`
`34`		`- public function key()`
	`34`	`+ public function key(): int`
`35`	`35`	`{`
`36`	`36`	`return $this->key;`
`37`	`37`	`}`
`@@ -41,7 +41,7 @@ public function key()`
`41`	`41`	`*`
`42`	`42`	`* @return void`
`43`	`43`	`*/`
`44`		`- public function rewind()`
	`44`	`+ public function rewind(): void`
`45`	`45`	`{`
`46`	`46`	`$this->key = 0;`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function count(): int`
`21`	`21`	`/**`
`22`	`22`	`* {@inheritdoc}`
`23`	`23`	`*/`
`24`		`- public function current()`
	`24`	`+ public function current(): mixed`
`25`	`25`	`{`
`26`	`26`	`return $this->dataset[$this->key];`
`27`	`27`	`}`
`@@ -39,7 +39,7 @@ public function next()`
`39`	`39`	`/**`
`40`	`40`	`* {@inheritdoc}`
`41`	`41`	`*/`
`42`		`- public function rewind()`
	`42`	`+ public function rewind(): void`
`43`	`43`	`{`
`44`	`44`	`$this->key = 0;`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function getMaxLimit(): int`
`54`	`54`	`*`
`55`	`55`	`* @return void`
`56`	`56`	`*/`
`57`		`- public function next()`
	`57`	`+ public function next(): void`
`58`	`58`	`{`
`59`	`59`	`[$this->current, $this->previous] = [$this->current + $this->previous, $this->current];`
`60`	`60`	`++$this->key;`
`@@ -63,7 +63,7 @@ public function next()`
`63`	`63`	`/**`
`64`	`64`	`* {@inheritdoc}`
`65`	`65`	`*/`
`66`		`- public function rewind()`
	`66`	`+ public function rewind(): void`
`67`	`67`	`{`
`68`	`68`	`$this->previous = 1;`
`69`	`69`	`$this->current = 0;`
`@@ -78,7 +78,7 @@ public function rewind()`
`78`	`78`	`*`
`79`	`79`	`* @return void`
`80`	`80`	`*/`
`81`		`- public function setMaxLimit($max)`
	`81`	`+ public function setMaxLimit($max): void`
`82`	`82`	`{`
`83`	`83`	`$this->max = $max;`
`84`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function count(): int`
`43`	`43`	`/**`
`44`	`44`	`* {@inheritdoc}`
`45`	`45`	`*/`
`46`		`- public function current()`
	`46`	`+ public function current(): mixed`
`47`	`47`	`{`
`48`	`48`	`return current($this->group);`
`49`	`49`	`}`
`@@ -64,7 +64,7 @@ public function getSize(): int`
`64`	`64`	`*`
`65`	`65`	`* @return void`
`66`	`66`	`*/`
`67`		`- public function next()`
	`67`	`+ public function next(): void`
`68`	`68`	`{`
`69`	`69`	`++$this->key;`
`70`	`70`	`next($this->group);`
`@@ -99,7 +99,7 @@ public function order($generator): int`
`99`	`99`	`*`
`100`	`100`	`* @return void`
`101`	`101`	`*/`
`102`		`- public function setSize($size)`
	`102`	`+ public function setSize($size): void`
`103`	`103`	`{`
`104`	`104`	`$this->size = $size;`
`105`	`105`	`$this->computeGroup();`
`@@ -120,7 +120,7 @@ public function valid(): bool`
`120`	`120`	`*`
`121`	`121`	`* @return void`
`122`	`122`	`*/`
`123`		`- private function computeGroup()`
	`123`	`+ private function computeGroup(): void`
`124`	`124`	`{`
`125`	`125`	`$this->group = [];`
`126`	`126`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(array $dataset = [], $length = 1)`
`35`	`35`	`/**`
`36`	`36`	`* {@inheritdoc}`
`37`	`37`	`*/`
`38`		`- public function current()`
	`38`	`+ public function current(): mixed`
`39`	`39`	`{`
`40`	`40`	`return $this->currentValue;`
`41`	`41`	`}`
`@@ -45,7 +45,7 @@ public function current()`
`45`	`45`	`*`
`46`	`46`	`* @return void`
`47`	`47`	`*/`
`48`		`- public function next()`
	`48`	`+ public function next(): void`
`49`	`49`	`{`
`50`	`50`	`parent::next();`
`51`	`51`	`$this->currentValue = array_slice($this->current, 0, $this->getLength());`
`@@ -56,7 +56,7 @@ public function next()`
`56`	`56`	`*`
`57`	`57`	`* @return void`
`58`	`58`	`*/`
`59`		`- public function rewind()`
	`59`	`+ public function rewind(): void`
`60`	`60`	`{`
`61`	`61`	`parent::rewind();`
`62`	`62`	`$this->currentValue = array_slice($this->current, 0, $this->getLength());`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function __construct()`
`37`	`37`	`/**`
`38`	`38`	`* {@inheritdoc}`
`39`	`39`	`*/`
`40`		`- public function current()`
	`40`	`+ public function current(): mixed`
`41`	`41`	`{`
`42`	`42`	`for ($i = $this->key(); $this->getMaxLimit() > $i; ++$i) {`
`43`	`43`	`if ($this->isPerfectNumber($i)) {`
`@@ -77,15 +77,15 @@ public function getMinLimit(): int`
`77`	`77`	`*`
`78`	`78`	`* @return void`
`79`	`79`	`*/`
`80`		`- public function next()`
	`80`	`+ public function next(): void`
`81`	`81`	`{`
`82`	`82`	`++$this->key;`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`/**`
`86`	`86`	`* {@inheritdoc}`
`87`	`87`	`*/`
`88`		`- public function rewind()`
	`88`	`+ public function rewind(): void`
`89`	`89`	`{`
`90`	`90`	`$this->key = $this->getMinLimit();`
`91`	`91`	`}`
`@@ -98,7 +98,7 @@ public function rewind()`
`98`	`98`	`*`
`99`	`99`	`* @return void`
`100`	`100`	`*/`
`101`		`- public function setMaxLimit($max)`
	`101`	`+ public function setMaxLimit($max): void`
`102`	`102`	`{`
`103`	`103`	`$this->max = $max;`
`104`	`104`	`}`
`@@ -111,7 +111,7 @@ public function setMaxLimit($max)`
`111`	`111`	`*`
`112`	`112`	`* @return void`
`113`	`113`	`*/`
`114`		`- public function setMinLimit($min)`
	`114`	`+ public function setMinLimit($min): void`
`115`	`115`	`{`
`116`	`116`	`$this->min = $min;`
`117`	`117`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function count(): int`
`38`	`38`	`/**`
`39`	`39`	`* {@inheritdoc}`
`40`	`40`	`*/`
`41`		`- public function current()`
	`41`	`+ public function current(): mixed`
`42`	`42`	`{`
`43`	`43`	`return current($this->factors);`
`44`	`44`	`}`
`@@ -59,7 +59,7 @@ public function getNumber(): int`
`59`	`59`	`*`
`60`	`60`	`* @return void`
`61`	`61`	`*/`
`62`		`- public function next()`
	`62`	`+ public function next(): void`
`63`	`63`	`{`
`64`	`64`	`++$this->key;`
`65`	`65`	`next($this->factors);`
`@@ -68,7 +68,7 @@ public function next()`
`68`	`68`	`/**`
`69`	`69`	`* {@inheritdoc}`
`70`	`70`	`*/`
`71`		`- public function rewind()`
	`71`	`+ public function rewind(): void`
`72`	`72`	`{`
`73`	`73`	`$this->key = 0;`
`74`	`74`	`}`
`@@ -81,7 +81,7 @@ public function rewind()`
`81`	`81`	`*`
`82`	`82`	`* @return void`
`83`	`83`	`*/`
`84`		`- public function setNumber($number)`
	`84`	`+ public function setNumber($number): void`
`85`	`85`	`{`
`86`	`86`	`$this->number = $number;`
`87`	`87`	`$this->factors = $this->getFactors($this->getNumber());`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function count(): int`
`53`	`53`	`/**`
`54`	`54`	`* {@inheritdoc}`
`55`	`55`	`*/`
`56`		`- public function current()`
	`56`	`+ public function current(): mixed`
`57`	`57`	`{`
`58`	`58`	`$tuple = [];`
`59`	`59`
`@@ -69,7 +69,7 @@ public function current()`
`69`	`69`	`*`
`70`	`70`	`* @return void`
`71`	`71`	`*/`
`72`		`- public function next()`
	`72`	`+ public function next(): void`
`73`	`73`	`{`
`74`	`74`	`foreach (array_reverse($this->iterators) as $key => $iterator) {`
`75`	`75`	`$iterator->next();`
`@@ -95,7 +95,7 @@ public function next()`
`95`	`95`	`*`
`96`	`96`	`* @return void`
`97`	`97`	`*/`
`98`		`- public function rewind()`
	`98`	`+ public function rewind(): void`
`99`	`99`	`{`
`100`	`100`	`foreach ($this->iterators as $iterator) {`
`101`	`101`	`$iterator->rewind();`