1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 292734 $ -->
<phpdoc:classref xml:id="class.multipleiterator" 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 MultipleIterator class</title>
<titleabbrev>MultipleIterator</titleabbrev>
<partintro>
<!-- {{{ MultipleIterator intro -->
<section xml:id="multipleiterator.intro">
&reftitle.intro;
<para>
An Iterator that iterates over several iterators one after the other.
</para>
</section>
<!-- }}} -->
<section xml:id="multipleiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MultipleIterator</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>MultipleIterator</classname>
</ooclass>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="multipleiterator.constants.mit-need-any">MultipleIterator::MIT_NEED_ANY</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="multipleiterator.constants.mit-need-all">MultipleIterator::MIT_NEED_ALL</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="multipleiterator.constants.mit-keys-numeric">MultipleIterator::MIT_KEYS_NUMERIC</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="multipleiterator.constants.mit-keys-assoc">MultipleIterator::MIT_KEYS_ASSOC</varname>
<initializer>2</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.multipleiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ MultipleIterator constants -->
<section xml:id="multipleiterator.constants">
&reftitle.constants;
<section xml:id="multipleiterator.constants.types">
<title>MultipleIterator Node Types</title>
<variablelist>
<varlistentry xml:id="multipleiterator.constants.mit-need-any">
<term><constant>MultipleIterator::MIT_NEED_ANY</constant></term>
<listitem>
<para>
Do not require all sub iterators to be valid in iteration.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="multipleiterator.constants.mit-need-all">
<term><constant>MultipleIterator::MIT_NEED_ALL</constant></term>
<listitem>
<para>
Require all sub iterators to be valid in iteration.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="multipleiterator.constants.mit-keys-numeric">
<term><constant>MultipleIterator::MIT_KEYS_NUMERIC</constant></term>
<listitem>
<para>
Keys are created from the sub iterators position.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="multipleiterator.constants.mit-keys-assoc">
<term><constant>MultipleIterator::MIT_KEYS_ASSOC</constant></term>
<listitem>
<para>
Keys are created from sub iterators associated information.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.spl.entities.multipleiterator;
</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
-->
|