php-doc-en/reference/spl/recursivearrayiterator.xml

124 lines
4 KiB
XML
Raw Permalink Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.recursivearrayiterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The RecursiveArrayIterator class</title>
<titleabbrev>RecursiveArrayIterator</titleabbrev>
<partintro>
<!-- {{{ RecursiveArrayIterator intro -->
<section xml:id="recursivearrayiterator.intro">
&reftitle.intro;
<para>
This iterator allows to unset and modify values and keys while iterating over Arrays and Objects
in the same way as the <type>ArrayIterator</type>. Additionally it is possible to iterate
over the current iterator entry.
</para>
</section>
<!-- }}} -->
<section xml:id="recursivearrayiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>RecursiveArrayIterator</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>RecursiveArrayIterator</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>ArrayIterator</classname>
</ooclass>
<oointerface>
<interfacename>RecursiveIterator</interfacename>
</oointerface>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
<xi:fallback />
</xi:include>
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivearrayiterator.constants.child-arrays-only">CHILD_ARRAYS_ONLY</varname>
<initializer>4</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivearrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
2021-08-12 08:50:15 +00:00
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
<section xml:id="recursivearrayiterator.constants">
&reftitle.constants;
<section xml:id="recursivearrayiterator.constants.flags">
<title>RecursiveArrayIterator Flags</title>
<variablelist>
<varlistentry xml:id="recursivearrayiterator.constants.child-arrays-only">
<term><constant>RecursiveArrayIterator::CHILD_ARRAYS_ONLY</constant></term>
<listitem>
<para>Treat only arrays (not objects) as having children for recursive iteration.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- {{{ RecursiveArrayIterator properties
<section xml:id="recursivearrayiterator.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="recursivearrayiterator.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
}}} -->
</partintro>
&reference.spl.entities.recursivearrayiterator;
</phpdoc:classref>
<!-- 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
-->