Use true as return types for SplHeap (#13147)

Author: Girgias

UPGRADING

@@ -311,6 +311,12 @@ PDO_SQLITE:
 - PGSQL:
   . pg_select, the conditions arguments accepts an empty array and is optional.
 
+- SPL:
+  . SplPriorityQueue::insert() and SplPriorityQueue::recoverFromCorruption()
+    now has a tentative return type of true
+  . SplHeap::insert() and SplHeap::recoverFromCorruption()
+    now has a tentative return type of true instead of bool
+
 - Standard:
   . The internal implementation for rounding to integers has been rewritten
     to be easier to verify for correctness and to be easier to maintain.

ext/spl/spl_heap.stub.php

@@ -14,8 +14,8 @@ class SplPriorityQueue implements Iterator, Countable
     /** @tentative-return-type */
     public function compare(mixed $priority1, mixed $priority2): int {}
 
-    /** @return true */
-    public function insert(mixed $value, mixed $priority) {} // TODO make return type void
+    /** @tentative-return-type */
+    public function insert(mixed $value, mixed $priority): true {}
 
     /** @tentative-return-type */
     public function setExtractFlags(int $flags): int {}
@@ -66,10 +66,10 @@ public function next(): void {}
     public function valid(): bool {}
 
     /**
-     * @return bool
+     * @tentative-return-type
      * @implementation-alias SplHeap::recoverFromCorruption
      */
-    public function recoverFromCorruption() {} // TODO make return type void
+    public function recoverFromCorruption(): true {}
 
     /**
      * @tentative-return-type
@@ -90,7 +90,7 @@ abstract class SplHeap implements Iterator, Countable
     public function extract(): mixed {}
 
     /** @tentative-return-type */
-    public function insert(mixed $value): bool {}
+    public function insert(mixed $value): true {}
 
     /** @tentative-return-type */
     public function top(): mixed {}
@@ -117,7 +117,7 @@ public function next(): void {}
     public function valid(): bool {}
 
     /** @tentative-return-type */
-    public function recoverFromCorruption(): bool {}
+    public function recoverFromCorruption(): true {}
 
     /** @tentative-return-type */
     abstract protected function compare(mixed $value1, mixed $value2): int;