reference/spl/multipleiterator/key.xml
d51166ca16fda8e766849505b84f9306ef443f71
d51166ca16fda8e766849505b84f9306ef443f71
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="multipleiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>MultipleIterator::key</refname>
...
...
@@ -9,9 +8,9 @@
9
8
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<methodsynopsis role="MultipleIterator">
13
12
<modifier>public</modifier> <type>array</type><methodname>MultipleIterator::key</methodname>
14
-
<void />
13
+
<void/>
15
14
</methodsynopsis>
16
15
<para>
17
16
Get the registered iterator instances key() result.
...
...
@@ -29,16 +28,15 @@
29
28
<refsect1 role="returnvalues">
30
29
&reftitle.returnvalues;
31
30
<para>
32
-
An <type>array</type> of all registered iterator instances,
33
-
or &false; if no sub iterator is attached.
31
+
An <type>array</type> of all registered iterator instances.
34
32
</para>
35
33
</refsect1>
36
34
37
35
<refsect1 role="errors">
38
36
&reftitle.errors;
39
37
<para>
40
-
A <classname>LogicException</classname> if mode <constant>MIT_NEED_ALL</constant> is set,
41
-
and at least one attached iterator is not valid.
38
+
A <classname>RuntimeException</classname> if the iterator is invalid (as of PHP 8.1.0), or
39
+
mode <constant>MIT_NEED_ALL</constant> is set, and at least one attached iterator is not valid.
42
40
</para>
43
41
<para>
44
42
Calling this method from <xref linkend="control-structures.foreach"/>
...
...
@@ -46,6 +44,30 @@
46
44
</para>
47
45
</refsect1>
48
46
47
+
<refsect1 role="changelog">
48
+
&reftitle.changelog;
49
+
<informaltable>
50
+
<tgroup cols="2">
51
+
<thead>
52
+
<row>
53
+
<entry>&Version;</entry>
54
+
<entry>&Description;</entry>
55
+
</row>
56
+
</thead>
57
+
<tbody>
58
+
<row>
59
+
<entry>8.1.0</entry>
60
+
<entry>
61
+
A <classname>RuntimeException</classname> is now thrown if
62
+
<methodname>MultipleIterator::key</methodname> is called on an
63
+
invalid iterator. Previously, &false; was returned.
64
+
</entry>
65
+
</row>
66
+
</tbody>
67
+
</tgroup>
68
+
</informaltable>
69
+
</refsect1>
70
+
49
71
<refsect1 role="seealso">
50
72
&reftitle.seealso;
51
73
<para>
...
...
@@ -56,7 +78,6 @@
56
78
</refsect1>
57
79
58
80
</refentry>
59
-
60
81
<!-- Keep this comment at the end of the file
61
82
Local variables:
62
83
mode: sgml
63
84