2009-07-03 18:53:19 +00:00
<?xml version="1.0" encoding="utf-8"?>
2009-07-11 08:59:47 +00:00
<!-- $Revision$ -->
2021-12-23 13:16:36 +00:00
<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" >
2009-07-03 18:53:19 +00:00
<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 >
2021-12-23 13:16:36 +00:00
<ooclass >
<classname > RecursiveArrayIterator</classname>
</ooclass>
2009-07-03 18:53:19 +00:00
<classsynopsisinfo >
<ooclass >
<classname > RecursiveArrayIterator</classname>
</ooclass>
<ooclass >
<modifier > extends</modifier>
<classname > ArrayIterator</classname>
</ooclass>
<oointerface >
<interfacename > RecursiveIterator</interfacename>
</oointerface>
</classsynopsisinfo>
2018-09-20 15:10:00 +00:00
<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>
2017-02-21 10:46:22 +00:00
<classsynopsisinfo role= "comment" > &Constants; </classsynopsisinfo>
<fieldsynopsis >
<modifier > const</modifier>
2020-11-02 15:39:04 +00:00
<type > int</type>
2017-02-21 10:46:22 +00:00
<varname linkend= "recursivearrayiterator.constants.child-arrays-only" > CHILD_ARRAYS_ONLY</varname>
<initializer > 4</initializer>
</fieldsynopsis>
2009-07-03 18:53:19 +00:00
2009-12-29 09:42:00 +00:00
<classsynopsisinfo role= "comment" > &Methods; </classsynopsisinfo>
2021-12-23 13:16:36 +00:00
<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>
2021-12-23 13:16:36 +00:00
<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>
2009-07-03 18:53:19 +00:00
</classsynopsis>
</section>
2017-02-21 10:46:22 +00:00
<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>
2009-07-03 18:53:19 +00:00
<!-- {{{ 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
2009-09-25 07:04:39 +00:00
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
2009-07-03 18:53:19 +00:00
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
-->