cvs: phpdoc /en/reference/spl iterators.xml multipleiterator.xml /en/reference/spl/multipleiterator attachiterator.xml construct.xml
containsiterator.xml countiterators.xml current.xml detachiterator.xml getflags.xml key.xml next.xml rewind.xml setflags.xml valid.xml
| From: | Philip Olson | Date: | Tue, 30 Jun 2009 03:13:56 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl iterators.xml multipleiterator.xml /en/reference/spl/multipleiterator attachiterator.xml construct.xml containsiterator.xml countiterators.xml current.xml detachiterator.xml getflags.xml key.xml next.xml rewind.xml setflags.xml valid.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-4284@lists.php.net to get a copy of this message | ||
philip Tue Jun 30 03:13:56 2009 UTC
Added files:
/phpdoc/en/reference/spl multipleiterator.xml
/phpdoc/en/reference/spl/multipleiterator attachiterator.xml
construct.xml
containsiterator.xml
countiterators.xml
current.xml
detachiterator.xml
getflags.xml key.xml
next.xml rewind.xml
setflags.xml valid.xml
Modified files:
/phpdoc/en/reference/spl iterators.xml
Log:
added skeletons for MultipleIterator
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/iterators.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/spl/iterators.xml diff -u phpdoc/en/reference/spl/iterators.xml:1.7 phpdoc/en/reference/spl/iterators.xml:1.8 --- phpdoc/en/reference/spl/iterators.xml:1.7 Tue Jun 30 00:54:36 2009 +++ phpdoc/en/reference/spl/iterators.xml Tue Jun 30 03:13:56 2009 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <part xml:id="spl.iterators" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> @@ -13,7 +13,6 @@ <section xml:id="spl.iterators.list"> <title>Undocumented Iterators</title> <simplelist> - <member><classname>MultipleIterator</classname></member> <member><classname>NoRewindIterator</classname></member> <member><classname>RecursiveArrayIterator</classname></member> <member><classname>RecursiveFilterIterator</classname></member> @@ -26,7 +25,6 @@ </partintro> <!-- TODO: Not documented - &reference.spl.multipleiterator; &reference.spl.norewinditerator; &reference.spl.recursivearrayiterator; &reference.spl.recursivefilteriterator; @@ -46,6 +44,7 @@ &reference.spl.infiniteiterator; &reference.spl.iteratoriterator; &reference.spl.limititerator; + &reference.spl.multipleiterator; &reference.spl.parentiterator; &reference.spl.recursivecachingiterator; &reference.spl.recursivedirectoryiterator; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator.xml +++ phpdoc/en/reference/spl/multipleiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <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:"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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/attachiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/attachiterator.xml +++ phpdoc/en/reference/spl/multipleiterator/attachiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.attachiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::attachIterator</refname> <refpurpose>Attaches iterator information</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::attachIterator</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>infos</parameter></methodparam> </methodsynopsis> <para> Attaches iterator information. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> The new iterator to attach. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>infos</parameter></term> <listitem> <para> The associative information for the Iterator, which must be an <type>integer</type>, a <type>string</type>, or &null;. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> An IllegalValueException if the <parameter>iterator</parameter> parameter is invalid, or if <parameter>infos</parameter> is already associated information. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::__construct</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/construct.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/construct.xml +++ phpdoc/en/reference/spl/multipleiterator/construct.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::__construct</refname> <refpurpose>Constructs a new MultipleIterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <methodname>MultipleIterator::__construct</methodname> <methodparam><type>integer</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> Construct a new MultipleIterator. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> The flags to set, according to the <link linkend="multipleiterator.constants">Flag Constants</link> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The iterator. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="multipleiterator.constants">Flag Constants</link></member> <member><methodname>MultipleIterator::valid</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/containsiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/containsiterator.xml +++ phpdoc/en/reference/spl/multipleiterator/containsiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.containsiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::containsIterator</refname> <refpurpose>Checks if an iterator is attached</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::containsIterator</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> </methodsynopsis> <para> Checks if an iterator is attached or not. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> The iterator to check. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::valid</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/countiterators.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/countiterators.xml +++ phpdoc/en/reference/spl/multipleiterator/countiterators.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.countiterators" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::countIterators</refname> <refpurpose>Gets the number of attached iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::countIterators</methodname> <void /> </methodsynopsis> <para> Gets the number of attached iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The number of attached iterator instances (as an <type>integer</type>). </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::containsIterator</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/current.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/current.xml +++ phpdoc/en/reference/spl/multipleiterator/current.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::current</refname> <refpurpose>Gets the registered iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::current</methodname> <void /> </methodsynopsis> <para> Get the registered iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An <type>array</type> of all registered iterator instances, or &false; if no sub iterator is attached. </para> </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> A <classname>RuntimeException</classname> if mode <constant>MIT_NEED_ALL</constant> is set and at least one attached iterator is not valid. Or an <classname>IllegalValueException</classname> if a key is &null; and <constant>MIT_KEYS_ASSOC</constant> is set. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::valid</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/detachiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/detachiterator.xml +++ phpdoc/en/reference/spl/multipleiterator/detachiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.detachiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::detachIterator</refname> <refpurpose>Detaches an iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::detachIterator</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> </methodsynopsis> <para> Detaches an iterator. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> The iterator to detach. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::attachIterator</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/getflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/getflags.xml +++ phpdoc/en/reference/spl/multipleiterator/getflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::getFlags</refname> <refpurpose>Gets the flag information</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::getFlags</methodname> <void /> </methodsynopsis> <para> Gets information about the flags. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Information about the flags, as an <type>integer</type>. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="multipleiterator.constants">Flag Constants</link></member> <member><methodname>MultipleIterator::__construct</methodname></member> <member><methodname>MultipleIterator::setFlags</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/key.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/key.xml +++ phpdoc/en/reference/spl/multipleiterator/key.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::key</refname> <refpurpose>Gets the registered iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::key</methodname> <void /> </methodsynopsis> <para> Get the registered iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An <type>array</type> of all registered iterator instances, or &false; if no sub iterator is attached. </para> </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> A LogicException if mode <constant>MIT_NEED_ALL</constant> is set, and at least one attached iterator is not valid. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::current</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/next.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/next.xml +++ phpdoc/en/reference/spl/multipleiterator/next.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::next</refname> <refpurpose>Moves all attached iterator instances forward</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::next</methodname> <void /> </methodsynopsis> <para> Moves all attached iterator instances forward. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::rewind</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/rewind.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/rewind.xml +++ phpdoc/en/reference/spl/multipleiterator/rewind.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::rewind</refname> <refpurpose>Rewinds all attached iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::rewind</methodname> <void /> </methodsynopsis> <para> Rewinds all attached iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::next</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/setflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/setflags.xml +++ phpdoc/en/reference/spl/multipleiterator/setflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::setFlags</refname> <refpurpose>Sets flags</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::setFlags</methodname> <methodparam><type>integer</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> Sets flags. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> The flags to set, according to the <link linkend="multipleiterator.constants">Flag Constants</link> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="multipleiterator.constants">Flag Constants</link></member> <member><methodname>MultipleIterator::__construct</methodname></member> <member><methodname>MultipleIterator::getFlags</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/valid.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/valid.xml +++ phpdoc/en/reference/spl/multipleiterator/valid.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::valid</refname> <refpurpose>Checks the validity of sub iterators</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::valid</methodname> <void /> </methodsynopsis> <para> Checks the validity of sub iterators. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &true; if one or all sub iterators are valid depending on flags, otherwise &false; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::__construct</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 -->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/iterators.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/spl/iterators.xml diff -u phpdoc/en/reference/spl/iterators.xml:1.7 phpdoc/en/reference/spl/iterators.xml:1.8 --- phpdoc/en/reference/spl/iterators.xml:1.7 Tue Jun 30 00:54:36 2009 +++ phpdoc/en/reference/spl/iterators.xml Tue Jun 30 03:13:56 2009 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <part xml:id="spl.iterators" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> @@ -13,7 +13,6 @@ <section xml:id="spl.iterators.list"> <title>Undocumented Iterators</title> <simplelist> - <member><classname>MultipleIterator</classname></member> <member><classname>NoRewindIterator</classname></member> <member><classname>RecursiveArrayIterator</classname></member> <member><classname>RecursiveFilterIterator</classname></member> @@ -26,7 +25,6 @@ </partintro> <!-- TODO: Not documented - &reference.spl.multipleiterator; &reference.spl.norewinditerator; &reference.spl.recursivearrayiterator; &reference.spl.recursivefilteriterator; @@ -46,6 +44,7 @@ &reference.spl.infiniteiterator; &reference.spl.iteratoriterator; &reference.spl.limititerator; + &reference.spl.multipleiterator; &reference.spl.parentiterator; &reference.spl.recursivecachingiterator; &reference.spl.recursivedirectoryiterator; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator.xml +++ phpdoc/en/reference/spl/multipleiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <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:"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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/attachiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/attachiterator.xml +++ phpdoc/en/reference/spl/multipleiterator/attachiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.attachiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::attachIterator</refname> <refpurpose>Attaches iterator information</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::attachIterator</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>infos</parameter></methodparam> </methodsynopsis> <para> Attaches iterator information. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> The new iterator to attach. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>infos</parameter></term> <listitem> <para> The associative information for the Iterator, which must be an <type>integer</type>, a <type>string</type>, or &null;. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> An IllegalValueException if the <parameter>iterator</parameter> parameter is invalid, or if <parameter>infos</parameter> is already associated information. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::__construct</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/construct.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/construct.xml +++ phpdoc/en/reference/spl/multipleiterator/construct.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::__construct</refname> <refpurpose>Constructs a new MultipleIterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <methodname>MultipleIterator::__construct</methodname> <methodparam><type>integer</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> Construct a new MultipleIterator. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> The flags to set, according to the <link linkend="multipleiterator.constants">Flag Constants</link> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The iterator. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="multipleiterator.constants">Flag Constants</link></member> <member><methodname>MultipleIterator::valid</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/containsiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/containsiterator.xml +++ phpdoc/en/reference/spl/multipleiterator/containsiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.containsiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::containsIterator</refname> <refpurpose>Checks if an iterator is attached</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::containsIterator</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> </methodsynopsis> <para> Checks if an iterator is attached or not. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> The iterator to check. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::valid</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/countiterators.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/countiterators.xml +++ phpdoc/en/reference/spl/multipleiterator/countiterators.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.countiterators" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::countIterators</refname> <refpurpose>Gets the number of attached iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::countIterators</methodname> <void /> </methodsynopsis> <para> Gets the number of attached iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The number of attached iterator instances (as an <type>integer</type>). </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::containsIterator</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/current.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/current.xml +++ phpdoc/en/reference/spl/multipleiterator/current.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::current</refname> <refpurpose>Gets the registered iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::current</methodname> <void /> </methodsynopsis> <para> Get the registered iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An <type>array</type> of all registered iterator instances, or &false; if no sub iterator is attached. </para> </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> A <classname>RuntimeException</classname> if mode <constant>MIT_NEED_ALL</constant> is set and at least one attached iterator is not valid. Or an <classname>IllegalValueException</classname> if a key is &null; and <constant>MIT_KEYS_ASSOC</constant> is set. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::valid</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/detachiterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/detachiterator.xml +++ phpdoc/en/reference/spl/multipleiterator/detachiterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.detachiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::detachIterator</refname> <refpurpose>Detaches an iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::detachIterator</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> </methodsynopsis> <para> Detaches an iterator. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> The iterator to detach. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::attachIterator</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/getflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/getflags.xml +++ phpdoc/en/reference/spl/multipleiterator/getflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::getFlags</refname> <refpurpose>Gets the flag information</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::getFlags</methodname> <void /> </methodsynopsis> <para> Gets information about the flags. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Information about the flags, as an <type>integer</type>. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="multipleiterator.constants">Flag Constants</link></member> <member><methodname>MultipleIterator::__construct</methodname></member> <member><methodname>MultipleIterator::setFlags</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/key.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/key.xml +++ phpdoc/en/reference/spl/multipleiterator/key.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::key</refname> <refpurpose>Gets the registered iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::key</methodname> <void /> </methodsynopsis> <para> Get the registered iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An <type>array</type> of all registered iterator instances, or &false; if no sub iterator is attached. </para> </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> A LogicException if mode <constant>MIT_NEED_ALL</constant> is set, and at least one attached iterator is not valid. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::current</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/next.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/next.xml +++ phpdoc/en/reference/spl/multipleiterator/next.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::next</refname> <refpurpose>Moves all attached iterator instances forward</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::next</methodname> <void /> </methodsynopsis> <para> Moves all attached iterator instances forward. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::rewind</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/rewind.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/rewind.xml +++ phpdoc/en/reference/spl/multipleiterator/rewind.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::rewind</refname> <refpurpose>Rewinds all attached iterator instances</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::rewind</methodname> <void /> </methodsynopsis> <para> Rewinds all attached iterator instances. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::next</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/setflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/setflags.xml +++ phpdoc/en/reference/spl/multipleiterator/setflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::setFlags</refname> <refpurpose>Sets flags</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::setFlags</methodname> <methodparam><type>integer</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> Sets flags. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> The flags to set, according to the <link linkend="multipleiterator.constants">Flag Constants</link> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="multipleiterator.constants">Flag Constants</link></member> <member><methodname>MultipleIterator::__construct</methodname></member> <member><methodname>MultipleIterator::getFlags</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/multipleiterator/valid.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/multipleiterator/valid.xml +++ phpdoc/en/reference/spl/multipleiterator/valid.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="multipleiterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>MultipleIterator::valid</refname> <refpurpose>Checks the validity of sub iterators</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>MultipleIterator::valid</methodname> <void /> </methodsynopsis> <para> Checks the validity of sub iterators. </para> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &true; if one or all sub iterators are valid depending on flags, otherwise &false; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>MultipleIterator::__construct</methodname></member> </simplelist> </para> </refsect1> </refentry> <!-- 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:"../../../../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 -->