php-doc-en/reference/spl/recursivetreeiterator.xml
Máté Kocsis c80e398bcb
Generate ext/spl class synopses from stubs - part 3 (#1224)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2021-12-21 15:31:10 +01:00

200 lines
6.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.recursivetreeiterator" 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 RecursiveTreeIterator class</title>
<titleabbrev>RecursiveTreeIterator</titleabbrev>
<partintro>
<!-- {{{ RecursiveTreeIterator intro -->
<section xml:id="recursivetreeiterator.intro">
&reftitle.intro;
<para>
Allows iterating over a <classname>RecursiveIterator</classname> to generate an ASCII graphic tree.
</para>
</section>
<!-- }}} -->
<section xml:id="recursivetreeiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>RecursiveTreeIterator</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>RecursiveTreeIterator</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>RecursiveIteratorIterator</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursiveiteratoriterator')/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="recursivetreeiterator.constants.bypass-current">RecursiveTreeIterator::BYPASS_CURRENT</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.bypass-key">RecursiveTreeIterator::BYPASS_KEY</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.prefix-left">RecursiveTreeIterator::PREFIX_LEFT</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.prefix-mid-has-next">RecursiveTreeIterator::PREFIX_MID_HAS_NEXT</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.prefix-mid-last">RecursiveTreeIterator::PREFIX_MID_LAST</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.prefix-end-has-next">RecursiveTreeIterator::PREFIX_END_HAS_NEXT</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.prefix-end-last">RecursiveTreeIterator::PREFIX_END_LAST</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="recursivetreeiterator.constants.prefix-right">RecursiveTreeIterator::PREFIX_RIGHT</varname>
<initializer>5</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivetreeiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivetreeiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursiveiteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ RecursiveTreeIterator constants -->
<section xml:id="recursivetreeiterator.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="recursivetreeiterator.constants.bypass-current">
<term><constant>RecursiveTreeIterator::BYPASS_CURRENT</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.bypass-key">
<term><constant>RecursiveTreeIterator::BYPASS_KEY</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.prefix-left">
<term><constant>RecursiveTreeIterator::PREFIX_LEFT</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.prefix-mid-has-next">
<term><constant>RecursiveTreeIterator::PREFIX_MID_HAS_NEXT</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.prefix-mid-last">
<term><constant>RecursiveTreeIterator::PREFIX_MID_LAST</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.prefix-end-has-next">
<term><constant>RecursiveTreeIterator::PREFIX_END_HAS_NEXT</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.prefix-end-last">
<term><constant>RecursiveTreeIterator::PREFIX_END_LAST</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="recursivetreeiterator.constants.prefix-right">
<term><constant>RecursiveTreeIterator::PREFIX_RIGHT</constant></term>
<listitem>
<para/>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.spl.entities.recursivetreeiterator;
</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
-->