xref: /PHP-8.0/ext/spl/spl_heap.stub.php (revision 64af12d1) 
1<?php
2
3/** @generate-function-entries */
4
5class SplPriorityQueue implements Iterator, Countable
6{
7    /** @return int */
8    public function compare(mixed $priority1, mixed $priority2) {}
9
10    /** @return bool */
11    public function insert(mixed $value, mixed $priority) {}
12
13    /** @return int */
14    public function setExtractFlags(int $flags) {}
15
16    /** @return mixed */
17    public function top() {}
18
19    /** @return mixed */
20    public function extract() {}
21
22    /**
23     * @return int
24     * @implementation-alias SplHeap::count
25     */
26    public function count() {}
27
28    /**
29     * @return bool
30     * @implementation-alias SplHeap::isEmpty
31     */
32    public function isEmpty() {}
33
34    /**
35     * @return void
36     * @implementation-alias SplHeap::rewind
37     */
38    public function rewind() {}
39
40    /** @return mixed */
41    public function current() {}
42
43    /**
44     * @return int
45     * @implementation-alias SplHeap::key
46     */
47    public function key() {}
48
49    /**
50     * @return void
51     * @implementation-alias SplHeap::next
52     */
53    public function next() {}
54
55    /**
56     * @return bool
57     * @implementation-alias SplHeap::valid
58     */
59    public function valid() {}
60
61    /**
62     * @return bool
63     * @implementation-alias SplHeap::recoverFromCorruption
64     */
65    public function recoverFromCorruption() {}
66
67    /**
68     * @return bool
69     * @implementation-alias SplHeap::isCorrupted
70     */
71    public function isCorrupted() {}
72
73    /** @return int */
74    public function getExtractFlags() {}
75
76    /** @return array */
77    public function __debugInfo() {}
78}
79
80abstract class SplHeap implements Iterator, Countable
81{
82    /** @return mixed */
83    public function extract() {}
84
85    /** @return bool */
86    public function insert(mixed $value) {}
87
88    /** @return mixed */
89    public function top() {}
90
91    /** @return int */
92    public function count() {}
93
94    /** @return bool */
95    public function isEmpty() {}
96
97    /** @return void */
98    public function rewind() {}
99
100    /** @return mixed */
101    public function current() {}
102
103    /** @return int */
104    public function key() {}
105
106    /** @return void */
107    public function next() {}
108
109    /** @return bool */
110    public function valid() {}
111
112    /** @return bool */
113    public function recoverFromCorruption() {}
114
115    /** @return int */
116    abstract protected function compare(mixed $value1, mixed $value2);
117
118    /** @return bool */
119    public function isCorrupted() {}
120
121    /** @return array */
122    public function __debugInfo() {}
123}
124
125class SplMinHeap extends SplHeap
126{
127    /** @return int */
128    protected function compare(mixed $value1, mixed $value2) {}
129}
130
131class SplMaxHeap extends SplHeap
132{
133    /** @return int */
134    protected function compare(mixed $value1, mixed $value2) {}
135}
136