File: LimitIterator.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (62 lines) | stat: -rw-r--r-- 2,562 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="LimitIterator" namespace="" name="LimitIterator">
  <implements name="OuterIterator" full="OuterIterator"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct a LimitIterator"/>
      <return type="void"/>
    </docblock>
    <parameter name="iterator" optional="false" byreference="false" type="object" class="Iterator"/>
    <parameter name="offset" optional="true" byreference="false" type="int"/>
    <parameter name="count" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get current element"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getInnerIterator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get inner iterator"/>
      <return type="Iterator"/>
    </docblock>
  </method>
  <method name="getPosition" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the current position"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get current key"/>
      <return type="mixed"/>
    </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="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind the iterator to the specified starting offset"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="seek" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Seek to the given position"/>
      <return type="int"/>
    </docblock>
    <parameter name="position" optional="false" byreference="false" type="int"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether the current element is valid"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>