Declare tentative return types for ext/spl - part 1

Author: kocsismate

ext/spl/spl_array.stub.php

@@ -8,87 +8,87 @@ public function __construct(array|object $array = [], int $flags = 0, string $it
 
     /**
      * @param string|int $key
-     * @return bool
+     * @tentative-return-type
      */
-    public function offsetExists($key) {}
+    public function offsetExists($key): bool {}
 
     /**
      * @param string|int $key
-     * @return mixed
+     * @tentative-return-type
      */
-    public function offsetGet($key) {}
+    public function offsetGet($key): mixed {}
 
     /**
      * @param string|int $key
-     * @return void
+     * @tentative-return-type
      */
-    public function offsetSet($key, mixed $value) {}
+    public function offsetSet($key, mixed $value): void {}
 
     /**
      * @param string|int $key
-     * @return void
+     * @tentative-return-type
      */
-    public function offsetUnset($key) {}
+    public function offsetUnset($key): void {}
 
-    /** @return void */
-    public function append(mixed $value) {}
+    /** @tentative-return-type */
+    public function append(mixed $value): void {}
 
-    /** @return array */
-    public function getArrayCopy() {}
+    /** @tentative-return-type */
+    public function getArrayCopy(): array {}
 
-    /** @return int */
-    public function count() {}
+    /** @tentative-return-type */
+    public function count(): int {}
 
-    /** @return int */
-    public function getFlags() {}
+    /** @tentative-return-type */
+    public function getFlags(): int {}
 
-    /** @return void */
-    public function setFlags(int $flags) {}
+    /** @tentative-return-type */
+    public function setFlags(int $flags): void {}
 
-    /** @return bool */
-    public function asort(int $flags = SORT_REGULAR) {}
+    /** @tentative-return-type */
+    public function asort(int $flags = SORT_REGULAR): bool {}
 
-    /** @return bool */
-    public function ksort(int $flags = SORT_REGULAR) {}
+    /** @tentative-return-type */
+    public function ksort(int $flags = SORT_REGULAR): bool {}
 
-    /** @return bool */
-    public function uasort(callable $callback) {}
+    /** @tentative-return-type */
+    public function uasort(callable $callback): bool {}
 
-    /** @return bool */
-    public function uksort(callable $callback) {}
+    /** @tentative-return-type */
+    public function uksort(callable $callback): bool {}
 
-    /** @return bool */
-    public function natsort() {}
+    /** @tentative-return-type */
+    public function natsort(): bool {}
 
-    /** @return bool */
-    public function natcasesort() {}
+    /** @tentative-return-type */
+    public function natcasesort(): bool {}
 
-    /** @return void */
-    public function unserialize(string $data) {}
+    /** @tentative-return-type */
+    public function unserialize(string $data): void {}
 
-    /** @return string */
-    public function serialize() {}
+    /** @tentative-return-type */
+    public function serialize(): string {}
 
-    /** @return array */
-    public function __serialize() {}
+    /** @tentative-return-type */
+    public function __serialize(): array {}
 
-    /** @return void */
-    public function __unserialize(array $data) {}
+    /** @tentative-return-type */
+    public function __unserialize(array $data): void {}
 
-    /** @return Iterator */
-    public function getIterator() {}
+    /** @tentative-return-type */
+    public function getIterator(): Iterator {}
 
-    /** @return array|null */
-    public function exchangeArray(array|object $array) {}
+    /** @tentative-return-type */
+    public function exchangeArray(array|object $array): ?array {}
 
-    /** @return void */
-    public function setIteratorClass(string $iteratorClass) {}
+    /** @tentative-return-type */
+    public function setIteratorClass(string $iteratorClass): void {}
 
-    /** @return string */
-    public function getIteratorClass() {}
+    /** @tentative-return-type */
+    public function getIteratorClass(): string {}
 
-    /** @return array */
-    public function __debugInfo() {}
+    /** @tentative-return-type */
+    public function __debugInfo(): array {}
 }
 
 class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable
@@ -97,152 +97,152 @@ public function __construct(array|object $array = [], int $flags = 0) {}
 
     /**
      * @param string|int $key
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::offsetExists
      */
-    public function offsetExists($key) {}
+    public function offsetExists($key): bool {}
 
     /**
      * @param string|int $key
-     * @return mixed
+     * @tentative-return-type
      * @implementation-alias ArrayObject::offsetGet
      */
-    public function offsetGet($key) {}
+    public function offsetGet($key): mixed {}
 
     /**
      * @param string|int $key
-     * @return void
+     * @tentative-return-type
      * @implementation-alias ArrayObject::offsetSet
      */
-    public function offsetSet($key, mixed $value) {}
+    public function offsetSet($key, mixed $value): void {}
 
     /**
      * @param string|int $key
-     * @return void
+     * @tentative-return-type
      * @implementation-alias ArrayObject::offsetUnset
      */
-    public function offsetUnset($key) {}
+    public function offsetUnset($key): void {}
 
     /**
-     * @return void
+     * @tentative-return-type
      * @implementation-alias ArrayObject::append
      */
-    public function append(mixed $value) {}
+    public function append(mixed $value): void {}
 
     /**
-     * @return array
+     * @tentative-return-type
      * @implementation-alias ArrayObject::getArrayCopy
      */
-    public function getArrayCopy() {}
+    public function getArrayCopy(): array {}
 
     /**
-     * @return int
+     * @tentative-return-type
      * @implementation-alias ArrayObject::count
      */
-    public function count() {}
+    public function count(): int {}
 
     /**
-     * @return int
+     * @tentative-return-type
      * @implementation-alias ArrayObject::getFlags
      */
-    public function getFlags() {}
+    public function getFlags(): int {}
 
     /**
-     * @return void
+     * @tentative-return-type
      * @implementation-alias ArrayObject::setFlags
      */
-    public function setFlags(int $flags) {}
+    public function setFlags(int $flags): void {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::asort
      */
-    public function asort(int $flags = SORT_REGULAR) {}
+    public function asort(int $flags = SORT_REGULAR): bool {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::ksort
      */
-    public function ksort(int $flags = SORT_REGULAR) {}
+    public function ksort(int $flags = SORT_REGULAR): bool {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::uasort
      */
-    public function uasort(callable $callback) {}
+    public function uasort(callable $callback): bool {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::uksort
      */
-    public function uksort(callable $callback) {}
+    public function uksort(callable $callback): bool {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::natsort
      */
-    public function natsort() {}
+    public function natsort(): bool {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias ArrayObject::natcasesort
      */
-    public function natcasesort() {}
+    public function natcasesort(): bool {}
 
     /**
-     * @return void
+     * @tentative-return-type
      * @implementation-alias ArrayObject::unserialize
      */
-    public function unserialize(string $data) {}
+    public function unserialize(string $data): void {}
 
     /**
-     * @return string
+     * @tentative-return-type
      * @implementation-alias ArrayObject::serialize
      */
-    public function serialize() {}
+    public function serialize(): string {}
 
     /**
-     * @return array
+     * @tentative-return-type
      * @implementation-alias ArrayObject::__serialize
      */
-    public function __serialize() {}
+    public function __serialize(): array {}
 
     /**
-     * @return void
+     * @tentative-return-type
      * @implementation-alias ArrayObject::__unserialize
      */
-    public function __unserialize(array $data) {}
+    public function __unserialize(array $data): void {}
 
-    /** @return void */
-    public function rewind() {}
+    /** @tentative-return-type */
+    public function rewind(): void {}
 
-    /** @return mixed */
-    public function current() {}
+    /** @tentative-return-type */
+    public function current(): mixed {}
 
-    /** @return mixed */
-    public function key() {}
+    /** @tentative-return-type */
+    public function key(): mixed {}
 
-    /** @return void */
-    public function next() {}
+    /** @tentative-return-type */
+    public function next(): void {}
 
-    /** @return bool */
-    public function valid() {}
+    /** @tentative-return-type */
+    public function valid(): bool {}
 
-    /** @return void */
-    public function seek(int $offset) {}
+    /** @tentative-return-type */
+    public function seek(int $offset): void {}
 
     /**
-     * @return array
+     * @tentative-return-type
      * @implementation-alias ArrayObject::__debugInfo
      */
-    public function __debugInfo() {}
+    public function __debugInfo(): array {}
 }
 
 class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator
 {
-    /** @return bool */
-    public function hasChildren() {}
+    /** @tentative-return-type */
+    public function hasChildren(): bool {}
 
-    /** @return RecursiveArrayIterator|null */
-    public function getChildren() {}
+    /** @tentative-return-type */
+    public function getChildren(): ?RecursiveArrayIterator {}
 }