reference/spl/functions/iterator-to-array.xml
70ac605e66b5ce0c03a345df92297f3e03f088ca
70ac605e66b5ce0c03a345df92297f3e03f088ca
...
...
@@ -10,8 +10,8 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>array</type><methodname>iterator_to_array</methodname>
13
-
<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
14
-
<methodparam choice="opt"><type>bool</type><parameter>use_keys</parameter><initializer>true</initializer></methodparam>
13
+
<methodparam><type class="union"><type>Traversable</type><type>array</type></type><parameter>iterator</parameter></methodparam>
14
+
<methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter><initializer>&true;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
Copy the elements of an iterator into an array.
...
...
@@ -31,11 +31,28 @@
31
31
</listitem>
32
32
</varlistentry>
33
33
<varlistentry>
34
-
<term><parameter>use_keys</parameter></term>
34
+
<term><parameter>preserve_keys</parameter></term>
35
35
<listitem>
36
36
<para>
37
37
Whether to use the iterator element keys as index.
38
38
</para>
39
+
<para>
40
+
If a key is an <type>array</type> or
41
+
<type>object</type>, a warning will be generated. &null; keys will be
42
+
converted to an empty string, <type>float</type> keys will be
43
+
truncated to their <type>int</type> counterpart,
44
+
<type>resource</type> keys will generate a warning and be converted to
45
+
their resource ID, and <type>bool</type> keys will be converted to
46
+
integers.
47
+
</para>
48
+
<note>
49
+
<para>
50
+
If this parameter is not set or set to &true;, duplicate keys will be
51
+
overwritten. The last value with a given key will be in the returned
52
+
<type>array</type>. Set this parameter to &false; to get all the values
53
+
in any case.
54
+
</para>
55
+
</note>
39
56
</listitem>
40
57
</varlistentry>
41
58
</variablelist>
...
...
@@ -51,26 +68,26 @@
51
68
52
69
<refsect1 role="changelog">
53
70
&reftitle.changelog;
54
-
<para>
55
-
<informaltable>
56
-
<tgroup cols="2">
57
-
<thead>
58
-
<row>
59
-
<entry>&Version;</entry>
60
-
<entry>&Description;</entry>
61
-
</row>
62
-
</thead>
63
-
<tbody>
64
-
<row>
65
-
<entry>5.2.1</entry>
66
-
<entry>
67
-
The <parameter>use_keys</parameter> parameter was added.
68
-
</entry>
69
-
</row>
70
-
</tbody>
71
-
</tgroup>
72
-
</informaltable>
73
-
</para>
71
+
<informaltable>
72
+
<tgroup cols="2">
73
+
<thead>
74
+
<row>
75
+
<entry>&Version;</entry>
76
+
<entry>&Description;</entry>
77
+
</row>
78
+
</thead>
79
+
<tbody>
80
+
<row>
81
+
<entry>8.2.0</entry>
82
+
<entry>
83
+
The type of <parameter>iterator</parameter> has been widened from
84
+
<type>Traversable</type> to
85
+
<type class="union"><type>Traversable</type><type>array</type></type>.
86
+
</entry>
87
+
</row>
88
+
</tbody>
89
+
</tgroup>
90
+
</informaltable>
74
91
</refsect1>
75
92
76
93
<refsect1 role="examples">
...
...
@@ -117,7 +134,6 @@ array(4) {
117
134
</refsect1>
118
135
119
136
</refentry>
120
-
121
137
<!-- Keep this comment at the end of the file
122
138
Local variables:
123
139
mode: sgml
124
140