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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.splfixedarray" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SplFixedArray class</title>
<titleabbrev>SplFixedArray</titleabbrev>
<partintro>
<!-- {{{ splfixedarray intro -->
<section xml:id="splfixedarray.intro">
&reftitle.intro;
<para>
The SplFixedArray class provides the main functionalities of array. The
main difference between a SplFixedArray and a normal PHP array is that
the SplFixedArray must be resized manually and allows only integers within
the range as indexes. The advantage is that it uses less memory than
a standard <type>array</type>.
</para>
</section>
<!-- }}} -->
<section xml:id="splfixedarray.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>SplFixedArray</classname>
</ooclass>
<oointerface>
<modifier>implements</modifier>
<interfacename>IteratorAggregate</interfacename>
</oointerface>
<oointerface>
<interfacename>ArrayAccess</interfacename>
</oointerface>
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
<oointerface>
<interfacename>JsonSerializable</interfacename>
</oointerface>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfixedarray')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SplFixedArray'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splfixedarray')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SplFixedArray'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.2.0</entry>
<entry>
The <methodname>SplFixedArray::__serialize</methodname> and
<methodname>SplFixedArray::__unserialize</methodname>
magic methods have been added to <classname>SplFixedArray</classname>.
</entry>
</row>
<row>
<entry>8.1.0</entry>
<entry>
<classname>SplFixedArray</classname> implements
<interfacename>JsonSerializable</interfacename> now.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<classname>SplFixedArray</classname> implements
<interfacename>IteratorAggregate</interfacename> now.
Previously, <interfacename>Iterator</interfacename> was implemented instead.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<!-- {{{ splfixedarray examples -->
<section xml:id="splfixedarray.examples">
&reftitle.examples;
<para>
<example>
<title><classname>SplFixedArray</classname> usage example</title>
<programlisting role="php">
<![CDATA[
<?php
// Initialize the array with a fixed length
$array = new SplFixedArray(5);
$array[1] = 2;
$array[4] = "foo";
var_dump($array[0]); // NULL
var_dump($array[1]); // int(2)
var_dump($array["4"]); // string(3) "foo"
// Increase the size of the array to 10
$array->setSize(10);
$array[9] = "asdf";
// Shrink the array to a size of 2
$array->setSize(2);
// The following lines throw a RuntimeException: Index invalid or out of range
try {
var_dump($array["non-numeric"]);
} catch(RuntimeException $re) {
echo "RuntimeException: ".$re->getMessage()."\n";
}
try {
var_dump($array[-1]);
} catch(RuntimeException $re) {
echo "RuntimeException: ".$re->getMessage()."\n";
}
try {
var_dump($array[5]);
} catch(RuntimeException $re) {
echo "RuntimeException: ".$re->getMessage()."\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
NULL
int(2)
string(3) "foo"
RuntimeException: Index invalid or out of range
RuntimeException: Index invalid or out of range
RuntimeException: Index invalid or out of range
]]>
</screen>
</example>
</para>
</section>
<!-- }}} -->
<!-- {{{ splfixedarray properties
<section xml:id="splfixedarray.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="splfixedarray.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
}}} -->
</partintro>
&reference.spl.entities.splfixedarray;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
