1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SplPriorityQueue" namespace="" name="SplPriorityQueue">
<implements name="Iterator" full="Iterator"/>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Constructs a new empty queue"/>
<return type="void"/>
</docblock>
</constructor>
<method name="compare" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Compare priorities in order to place elements correctly in the heap while sifting up"/>
<return type="int"/>
</docblock>
<parameter name="priority1" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="priority2" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="count" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Counts the number of elements in the queue"/>
<return type="int"/>
</docblock>
</method>
<method name="current" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return current node pointed by the iterator"/>
<return type="mixed"/>
</docblock>
</method>
<method name="extract" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Extracts a node from top of the heap and sift up"/>
<return type="mixed"/>
</docblock>
</method>
<method name="getExtractFlags" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get the flags of extraction"/>
<return type="int"/>
</docblock>
</method>
<method name="insert" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Inserts an element in the queue by sifting it up"/>
<return type="void"/>
</docblock>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="isCorrupted" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Tells if the priority queue is in a corrupted state"/>
<return type="bool"/>
</docblock>
</method>
<method name="isEmpty" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Checks whether the queue is empty"/>
<return type="bool"/>
</docblock>
</method>
<method name="key" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return current node index"/>
<return type="mixed"/>
</docblock>
</method>
<method name="next" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Move to the next node"/>
<return type="void"/>
</docblock>
</method>
<method name="recoverFromCorruption" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Recover from the corrupted state and allow further actions on the queue"/>
<return type="void"/>
</docblock>
</method>
<method name="rewind" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Rewind iterator back to the start (no-op)"/>
<return type="void"/>
</docblock>
</method>
<method name="setExtractFlags" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets the mode of extraction"/>
<return type="void"/>
</docblock>
<parameter name="flags" optional="false" byreference="false" type="int"/>
</method>
<method name="top" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Peeks at the node from the top of the queue"/>
<return type="mixed"/>
</docblock>
</method>
<method name="valid" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Check whether the queue contains more nodes"/>
<return type="bool"/>
</docblock>
</method>
</class>
|