🚨 Fix tentative return type issues

Author: homersimpsons

composer-require-checker.json

@@ -2,7 +2,16 @@
   "symbol-whitelist" : [
     "null", "true", "false",
     "static", "self", "parent",
-    "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object",
+    "array",
+    "string",
+    "int",
+    "float",
+    "bool",
+    "iterable",
+    "callable",
+    "void",
+    "object",
+    "mixed",
     "WeakRef", "WeakReference",
     "TheCodingMachine\\TDBM\\Fixtures\\Interfaces\\TestUserDaoInterface",
     "TheCodingMachine\\TDBM\\Fixtures\\Traits\\TestUserDaoTrait",

phpstan.neon

@@ -7,20 +7,12 @@ parameters:
     excludePaths:
      - src/SafeFunctions.php # Temporary exclude, delete this file in PHP ^8.0
      - src/Test/* # Files generated during TDBM test
-     - src/AlterableResultIterator.php # TODO: Add tentative return type
-     - src/EmptyInnerResultIterator.php # TODO: Add tentative return type
-     - src/PageIterator.php # TODO: Add tentative return type
-     - src/ResultIterator.php # TODO: Add tentative return type
-     - src/InnerResultIterator.php # TODO: Add tentative return type
-     - src/InnerResultArray.php # TODO: Add tentative return type
-     - src/MapIterator.php # TODO: Add tentative return type
-     - src/TDBMObject.php # TODO: Add tentative return type
     ignoreErrors:
      -
        identifier: missingType.iterableValue
      -
        identifier: missingType.generics
-     #- "#Method JsonSerializable::jsonSerialize\\(\\) invoked with 1 parameter, 0 required.#"
+     - "#Method JsonSerializable::jsonSerialize\\(\\) invoked with 1 parameter, 0 required.#"
      - "#Call to an undefined method object::#"
      - "#expects TheCodingMachine\\\\TDBM\\\\AbstractTDBMObject, object given.#"
      - '#Method TheCodingMachine\\TDBM\\NativeWeakrefObjectStorage::get\(\) should return TheCodingMachine\\TDBM\\DbRow\|null but returns object\|null.#'

src/AlterableResultIterator.php

@@ -140,7 +140,7 @@ public function toArray(): array
      *
      * @since 5.0.0
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return isset($this->toArray()[$offset]);
     }
@@ -158,7 +158,7 @@ public function offsetExists($offset)
      *
      * @since 5.0.0
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         return $this->toArray()[$offset];
     }
@@ -209,7 +209,7 @@ public function take(int $offset, int $limit): PageInterface
      *
      * @return int
      */
-    public function count()
+    public function count(): int
     {
         if ($this->resultIterator instanceof \Countable && $this->alterations->count() === 0) {
             return $this->resultIterator->count();
@@ -222,7 +222,7 @@ public function count()
      *
      * @return \Traversable
      */
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         if ($this->alterations->count() === 0) {
             if ($this->resultIterator !== null) {
@@ -245,7 +245,7 @@ public function getIterator()
      *
      * @since 5.4.0
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }

src/EmptyInnerResultIterator.php

@@ -15,7 +15,7 @@ class EmptyInnerResultIterator implements Iterator, InnerResultIteratorInterface
      * @return mixed Can return any type.
      * @since 5.0.0
      */
-    public function current()
+    public function current(): mixed
     {
         return null;
     }
@@ -26,7 +26,7 @@ public function current()
      * @return void Any returned value is ignored.
      * @since 5.0.0
      */
-    public function next()
+    public function next(): void
     {
     }
 
@@ -36,7 +36,7 @@ public function next()
      * @return mixed scalar on success, or null on failure.
      * @since 5.0.0
      */
-    public function key()
+    public function key(): mixed
     {
         return null;
     }
@@ -48,7 +48,7 @@ public function key()
      * Returns true on success or false on failure.
      * @since 5.0.0
      */
-    public function valid()
+    public function valid(): bool
     {
         return false;
     }
@@ -59,7 +59,7 @@ public function valid()
      * @return void Any returned value is ignored.
      * @since 5.0.0
      */
-    public function rewind()
+    public function rewind(): void
     {
     }
 
@@ -75,7 +75,7 @@ public function rewind()
      * The return value will be casted to boolean if non-boolean was returned.
      * @since 5.0.0
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return false;
     }
@@ -89,7 +89,7 @@ public function offsetExists($offset)
      * @return mixed Can return all value types.
      * @since 5.0.0
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.');
     }
@@ -134,7 +134,7 @@ public function offsetUnset($offset): void
      * The return value is cast to an integer.
      * @since 5.1.0
      */
-    public function count()
+    public function count(): int
     {
         return 0;
     }

src/InnerResultArray.php

@@ -52,7 +52,7 @@ class InnerResultArray extends InnerResultIterator
      *
      * @since 5.0.0
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         try {
             $this->toIndex($offset);
@@ -76,7 +76,7 @@ public function offsetExists($offset)
      *
      * @since 5.0.0
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         $this->toIndex($offset);
 
@@ -121,7 +121,7 @@ public function next(): void
      * Overloads the rewind implementation.
      * Do not reexecute the query.
      */
-    public function rewind()
+    public function rewind(): void
     {
         if (!$this->fetchStarted) {
             $this->executeQuery();

src/InnerResultIterator.php

@@ -34,8 +34,7 @@
  */
 class InnerResultIterator implements \Iterator, InnerResultIteratorInterface
 {
-    /** @var Result */
-    protected $result;
+    protected ?Result $result = null;
 
     /** @var bool */
     protected $fetchStarted = false;
@@ -126,7 +125,7 @@ protected function executeQuery(): void
      *
      * @return int
      */
-    public function count()
+    public function count(): int
     {
         if ($this->count !== null) {
             return $this->count;
@@ -160,7 +159,7 @@ private function getRowCountViaSqlQuery(): int
      *
      * @return AbstractTDBMObject
      */
-    public function current()
+    public function current(): mixed
     {
         return $this->current;
     }
@@ -170,7 +169,7 @@ public function current()
      *
      * @return int
      */
-    public function key()
+    public function key(): mixed
     {
         return $this->key;
     }
@@ -269,7 +268,7 @@ public function next(): void
     /**
      * Moves the cursor to the beginning of the result set.
      */
-    public function rewind()
+    public function rewind(): void
     {
         $this->executeQuery();
         $this->key = -1;
@@ -280,7 +279,7 @@ public function rewind()
      *
      * @return bool
      */
-    public function valid()
+    public function valid(): bool
     {
         return $this->current !== null;
     }
@@ -301,7 +300,7 @@ public function valid()
      *
      * @since 5.0.0
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
     }
@@ -319,7 +318,7 @@ public function offsetExists($offset)
      *
      * @since 5.0.0
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
     }

src/MapIterator.php

@@ -64,32 +64,32 @@ public function __construct($iterator, callable $callable)
      *
      * @return mixed
      */
-    public function current()
+    public function current(): mixed
     {
         $callable = $this->callable;
 
         return $callable($this->iterator->current());
     }
 
-    public function next()
+    public function next(): void
     {
         $this->iterator->next();
     }
 
     /**
      * @return mixed
      */
-    public function key()
+    public function key(): mixed
     {
         return $this->iterator->key();
     }
 
-    public function valid()
+    public function valid(): bool
     {
         return $this->iterator->valid();
     }
 
-    public function rewind()
+    public function rewind(): void
     {
         $this->iterator->rewind();
     }
@@ -104,7 +104,7 @@ public function toArray(): array
         return iterator_to_array($this);
     }
 
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }

src/PageIterator.php

@@ -117,7 +117,7 @@ public static function createEmpyIterator(ResultIterator $parentResult): self
      *
      * @return InnerResultIteratorInterface
      */
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         if ($this->innerResultIterator === null) {
             if ($this->parentResult->count() === 0) {
@@ -204,7 +204,7 @@ public function map(callable $callable): MapIterator
      *
      * @since 5.0.0
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return $this->getIterator()->offsetExists($offset);
     }
@@ -222,7 +222,7 @@ public function offsetExists($offset)
      *
      * @since 5.0.0
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         return $this->getIterator()->offsetGet($offset);
     }
@@ -272,7 +272,7 @@ public function offsetUnset($offset): void
      *
      * @since 5.4.0
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return array_map(function (AbstractTDBMObject $item) {
             return $item->jsonSerialize();

src/ResultIterator.php

@@ -160,7 +160,7 @@ public function map(callable $callable): MapIterator
      *
      * @return InnerResultIteratorInterface
      */
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         if ($this->innerResultIterator === null) {
             if ($this->totalCount === 0) {
@@ -199,7 +199,7 @@ public function take(int $offset, int $limit): PageIterator
      *
      * @since 5.0.0
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return $this->getIterator()->offsetExists($offset);
     }
@@ -217,7 +217,7 @@ public function offsetExists($offset)
      *
      * @since 5.0.0
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         return $this->getIterator()->offsetGet($offset);
     }
@@ -271,7 +271,7 @@ public function offsetUnset($offset): void
      *
      * @since 5.4.0
      */
-    public function jsonSerialize($stopRecursion = false)
+    public function jsonSerialize($stopRecursion = false): mixed
     {
         return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) {
             return $item->jsonSerialize($stopRecursion);

src/TDBMObject.php

@@ -64,7 +64,7 @@ public function setProperty(string $var, $value, string $tableName = null): void
      *
      * @since 5.4.0
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         throw new TDBMException('Json serialization is only implemented for generated beans.');
     }