[doc-en] master: RecursiveIteratorIterator: refer to callGetChildren() instead of getChildren() (#5979)
| From: | qodelicious via GitHub | Date: | Tue, 20 Oct 2026 12:35:18 +0000 |
| Subject: | [doc-en] master: RecursiveIteratorIterator: refer to callGetChildren() instead of getChildren() (#5979) | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-23866@lists.php.net to get a copy of this message | ||
Author: qodelicious (qodelicious)
Committer: GitHub (web-flow)
Pusher: lacatoire
Date: 2026-10-20T14:35:14+02:00
Commit: https://github.com/php/doc-en/commit/60c33b2a103077ab5e30090c3380f2971c7bb787
Raw diff: https://github.com/php/doc-en/commit/60c33b2a103077ab5e30090c3380f2971c7bb787.diff
RecursiveIteratorIterator: refer to callGetChildren() instead of getChildren() (#5979)
* RecursiveIteratorIterator: refer to callGetChildren() instead of a nonexistent getChildren()
* Mention that RecursiveIteratorIterator forwards unknown method calls
Changed paths:
M reference/spl/recursiveiteratoriterator.xml
M reference/spl/recursiveiteratoriterator/beginchildren.xml
M reference/spl/recursiveiteratoriterator/construct.xml
Diff:
diff --git a/reference/spl/recursiveiteratoriterator.xml
b/reference/spl/recursiveiteratoriterator.xml
index b42c86abbbfd..faed6e83dc10 100644
--- a/reference/spl/recursiveiteratoriterator.xml
+++ b/reference/spl/recursiveiteratoriterator.xml
@@ -12,6 +12,13 @@
<para>
Can be used to iterate through recursive iterators.
</para>
+ <simpara>
+ Calls to methods that <classname>RecursiveIteratorIterator</classname>
+ does not have are forwarded to the iterator at the current depth,
+ as returned by
+ <methodname>RecursiveIteratorIterator::getSubIterator</methodname>.
+ This does not use <link linkend="object.call">__call()</link>.
+ </simpara>
</section>
<!-- }}} -->
diff --git a/reference/spl/recursiveiteratoriterator/beginchildren.xml
b/reference/spl/recursiveiteratoriterator/beginchildren.xml
index c57c7b322a7c..7d25f4b34786 100644
--- a/reference/spl/recursiveiteratoriterator/beginchildren.xml
+++ b/reference/spl/recursiveiteratoriterator/beginchildren.xml
@@ -12,10 +12,10 @@
<modifier>public</modifier>
<type>void</type><methodname>RecursiveIteratorIterator::beginChildren</methodname>
<void/>
</methodsynopsis>
- <para>
- Is called after calling
<methodname>RecursiveIteratorIterator::getChildren</methodname>,
+ <simpara>
+ Is called after calling
<methodname>RecursiveIteratorIterator::callGetChildren</methodname>,
and its associated <methodname>RecursiveIteratorIterator::rewind</methodname>.
- </para>
+ </simpara>
&warn.undocumented.func;
diff --git a/reference/spl/recursiveiteratoriterator/construct.xml
b/reference/spl/recursiveiteratoriterator/construct.xml
index a53cec538633..41b1ca48a4dc 100644
--- a/reference/spl/recursiveiteratoriterator/construct.xml
+++ b/reference/spl/recursiveiteratoriterator/construct.xml
@@ -57,10 +57,10 @@
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
- <para>
+ <simpara>
Optional flag. Possible values are
<constant>RecursiveIteratorIterator::CATCH_GET_CHILD</constant>
- which will then ignore exceptions thrown in calls to
<methodname>RecursiveIteratorIterator::getChildren</methodname>.
- </para>
+ which will then ignore exceptions thrown in calls to
<methodname>RecursiveIteratorIterator::callGetChildren</methodname>.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>