File: SplFixedArray.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 (109 lines) | stat: -rw-r--r-- 4,648 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SplFixedArray" namespace="" name="SplFixedArray">
  <implements name="Iterator" full="Iterator"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a new fixed array"/>
      <return type="void"/>
    </docblock>
    <parameter name="size" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the size of the array"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return current array entry"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="fromArray" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Import a PHP array in a SplFixedArray instance"/>
      <return type="SplFixedArray"/>
    </docblock>
    <parameter name="array" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="save_indexes" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="getSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the size of the array"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return current array index"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to next entry"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether the requested index exists"/>
      <return type="bool"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value at the specified index"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets a new value at a specified index"/>
      <return type="void"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
    <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="Unsets the value at the specified $index"/>
      <return type="void"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind iterator back to the start"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="setSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Change the size of an array"/>
      <return type="bool"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
  </method>
  <method name="toArray" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns a PHP array from the fixed array"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether the array contains more elements"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="__wakeup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Reinitialises the array after being unserialised"/>
      <return type="void"/>
    </docblock>
  </method>
</class>