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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="CachingIterator" namespace="" name="CachingIterator">
<implements name="OuterIterator" full="OuterIterator"/>
<constant name="CALL_TOSTRING" value="1">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="CATCH_GET_CHILD" value="16">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="TOSTRING_USE_KEY" value="2">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="TOSTRING_USE_CURRENT" value="4">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="TOSTRING_USE_INNER" value="8">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constant name="FULL_CACHE" value="256">
<docblock>
<var type="integer"/>
</docblock>
</constant>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Construct a new CachingIterator object for the iterator"/>
<return type="void"/>
</docblock>
<parameter name="iterator" optional="false" byreference="false" type="object" class="Iterator"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</constructor>
<method name="count" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The number of elements in the iterator"/>
<return type="int"/>
</docblock>
</method>
<method name="current" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return the current element"/>
<return type="void"/>
</docblock>
</method>
<method name="getCache" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve the contents of the cache">Retrieve the contents of the cache.</description>
<return type="array"/>
</docblock>
</method>
<method name="getFlags" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Get flags used"/>
<return type="int"/>
</docblock>
</method>
<method name="getInnerIterator" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the inner iterator"/>
<return type="Iterator"/>
</docblock>
</method>
<method name="hasNext" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Check whether the inner iterator has a valid next element"/>
<return type="void"/>
</docblock>
</method>
<method name="key" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return the key for the current element"/>
<return type="scalar"/>
</docblock>
</method>
<method name="next" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Move the iterator forward"/>
<return type="void"/>
</docblock>
</method>
<method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The offsetExists purpose"/>
<return type="void"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The offsetGet purpose"/>
<return type="void"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="string"/>
</method>
<method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The offsetSet purpose"/>
<return type="void"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="newval" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="offsetUnset" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The offsetUnset purpose"/>
<return type="void"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="string"/>
</method>
<method name="rewind" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Rewind the iterator"/>
<return type="void"/>
</docblock>
</method>
<method name="setFlags" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The setFlags purpose"/>
<return type="void"/>
</docblock>
<parameter name="flags" optional="false" byreference="false" type="int"/>
</method>
<method name="__toString" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Return the string representation of the current element"/>
<return type="void"/>
</docblock>
</method>
<method name="valid" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Check whether the current element is valid"/>
<return type="void"/>
</docblock>
</method>
</class>
|