cvs: phpdoc /en/reference/spl cachingiterator.xml /en/reference/spl/cachingiterator construct.xml count.xml current.xml getcache.xml getflags.xml
getinneriterator.xml hasnext.xml key.xml next.xml offsetexists.xml offsetget.xml offsetset.xml offsetunset.xml rewind.xml setflags.xml tostring.xml
valid.xml
| From: | Brett Bieber | Date: | Fri, 14 Nov 2008 18:56:21 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl cachingiterator.xml /en/reference/spl/cachingiterator construct.xml count.xml current.xml getcache.xml getflags.xml getinneriterator.xml hasnext.xml key.xml next.xml offsetexists.xml offsetget.xml offsetset.xml offsetunset.xml rewind.xml setflags.xml tostring.xml valid.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2530@lists.php.net to get a copy of this message | ||
saltybeagle Fri Nov 14 18:56:21 2008 UTC
Added files:
/phpdoc/en/reference/spl/cachingiterator offsetget.xml getflags.xml
current.xml construct.xml
offsetunset.xml
offsetset.xml setflags.xml
count.xml key.xml
offsetexists.xml
getcache.xml
getinneriterator.xml
Modified files:
/phpdoc/en/reference/spl/cachingiterator valid.xml hasnext.xml
rewind.xml tostring.xml
next.xml
/phpdoc/en/reference/spl cachingiterator.xml
Log:
Add the class constants and starting point for the missing methods.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/valid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/valid.xml diff -u phpdoc/en/reference/spl/cachingiterator/valid.xml:1.4 phpdoc/en/reference/spl/cachingiterator/valid.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/valid.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/valid.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.valid" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::valid</refname> <refpurpose>Check whether the current element is valid</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>CachingIterator::valid</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::valid</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/hasnext.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/hasnext.xml diff -u phpdoc/en/reference/spl/cachingiterator/hasnext.xml:1.4 phpdoc/en/reference/spl/cachingiterator/hasnext.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/hasnext.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/hasnext.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.hasnext" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.hasnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::hasNext</refname> <refpurpose>Check whether the inner iterator has a valid next element</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>CachingIterator::hasNext</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::hasNext</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/rewind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/rewind.xml diff -u phpdoc/en/reference/spl/cachingiterator/rewind.xml:1.4 phpdoc/en/reference/spl/cachingiterator/rewind.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/rewind.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/rewind.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.rewind" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::rewind</refname> <refpurpose>Rewind the iterator</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>void</type><methodname>CachingIterator::rewind</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::rewind</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/tostring.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/tostring.xml diff -u phpdoc/en/reference/spl/cachingiterator/tostring.xml:1.5 phpdoc/en/reference/spl/cachingiterator/tostring.xml:1.6 --- phpdoc/en/reference/spl/cachingiterator/tostring.xml:1.5 Thu Jun 5 05:03:04 2008 +++ phpdoc/en/reference/spl/cachingiterator/tostring.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="cachingiterator.tostring" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6 $ --> + +<refentry xml:id="cachingiterator.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::__toString</refname> <refpurpose>Return the string representation of the current element</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>string</type><methodname>CachingIterator::__toString</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::__toString</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/next.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/next.xml diff -u phpdoc/en/reference/spl/cachingiterator/next.xml:1.4 phpdoc/en/reference/spl/cachingiterator/next.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/next.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/next.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.next" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::next</refname> <refpurpose>Move the iterator forward</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>void</type><methodname>CachingIterator::next</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::next</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator.xml diff -u phpdoc/en/reference/spl/cachingiterator.xml:1.4 phpdoc/en/reference/spl/cachingiterator.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator.xml:1.4 Sat Aug 23 14:09:14 2008 +++ phpdoc/en/reference/spl/cachingiterator.xml Fri Nov 14 18:56:21 2008 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.cachingiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>The CachingIterator class</title> <titleabbrev>CachingIterator</titleabbrev> @@ -10,7 +10,7 @@ <section xml:id="cachingiterator.intro"> &reftitle.intro; <para> - ... + This object supports cached iteration over another iterator. </para> </section> <!-- }}} --> @@ -45,46 +45,118 @@ <interfacename>Iterator</interfacename> </oointerface> - <oointerface> + <oointerface> <interfacename>ArrayAccess</interfacename> </oointerface> <oointerface> <interfacename>Countable</interfacename> </oointerface> - </classsynopsisinfo> <!-- }}} --> - - <!-- {{{ If the property is documented below (xml:id=cachingiterator.props) use this - <classsynopsisinfo role="comment">Properties</classsynopsisinfo> + <classsynopsisinfo role="comment">Constants</classsynopsisinfo> <fieldsynopsis> - <modifier>public</modifier> - <type>string</type> - <varname linkend="cachingiterator.props.name">name</varname> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.call-tostring">CachingIterator::CALL_TOSTRING</varname> + <initializer>1</initializer> </fieldsynopsis> - }}} --> - + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.catch-get-child">CachingIterator::CATCH_GET_CHILD</varname> + <initializer>16</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.tostring-use-key">CachingIterator::TOSTRING_USE_KEY</varname> + <initializer>2</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.tostring-use-current">CachingIterator::TOSTRING_USE_CURRENT</varname> + <initializer>4</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.tostring-use-inner">CachingIterator::TOSTRING_USE_INNER</varname> + <initializer>8</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.full-cache">CachingIterator::FULL_CACHE</varname> + <initializer>256</initializer> + </fieldsynopsis> + <classsynopsisinfo role="comment">Methods</classsynopsisinfo> <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> + + <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo> + <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> + </classsynopsis> - +<!-- }}} --> + </section> - -<!-- {{{ CachingIterator properties - <section xml:id="cachingiterator.props"> - &reftitle.properties; - <variablelist> - <varlistentry xml:id="cachingiterator.props.name"> - <term><varname>name</varname></term> - <listitem> - <para>Prop description</para> - </listitem> - </varlistentry> - </variablelist> + <!-- {{{ CachingIterator constants --> + <section xml:id="cachingiterator.constants"> + &reftitle.constants; + <section xml:id="cachingiterator.constants.types"> + <title>CachingIterator Node Types</title> + <variablelist> + + <varlistentry xml:id="cachingiterator.constants.call-tostring"> + <term><constant>CachingIterator::CALL_TOSTRING</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.catch-get-child"> + <term><constant>CachingIterator::CATCH_GET_CHILD</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.tostring-use-key"> + <term><constant>CachingIterator::TOSTRING_USE_KEY</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.tostring-use-current"> + <term><constant>CachingIterator::TOSTRING_USE_CURRENT</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.tostring-use-inner"> + <term><constant>CachingIterator::TOSTRING_USE_INNER</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.full-cache"> + <term><constant>CachingIterator::FULL_CACHE</constant></term> + <listitem> + <para>Cache all read data.</para> + </listitem> + </varlistentry> + + </variablelist> + </section> </section> -}}} --> - +<!-- }}} --> + + </partintro> &reference.spl.entities.cachingiterator; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/offsetget.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetget.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetget.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetGet</refname> <refpurpose>The offsetGet purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetGet</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetGet</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/getflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/getflags.xml +++ phpdoc/en/reference/spl/cachingiterator/getflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::getFlags</refname> <refpurpose>Get flags used</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getFlags</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> Get the bitmask of the flags used for this CachingIterator instance. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </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/cachingiterator/current.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/current.xml +++ phpdoc/en/reference/spl/cachingiterator/current.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::current</refname> <refpurpose>Return the current element</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::current</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> May return the current element in the iteration. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Mixed </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Iterator::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/cachingiterator/construct.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/construct.xml +++ phpdoc/en/reference/spl/cachingiterator/construct.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::__construct</refname> <refpurpose>Construct a new CachingIterator object for the iterator.</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <methodname>CachingIterator::__construct</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> Iterator to cache </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Bitmask of flags. </para> </listitem> </varlistentry> </variablelist> </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/cachingiterator/offsetunset.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetunset.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetunset.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetUnset</refname> <refpurpose>The offsetUnset purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetUnset</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetUnset</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/offsetset.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetset.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetset.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetSet</refname> <refpurpose>The offsetSet purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetSet</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> <methodparam><type>string</type><parameter>newval</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> <varlistentry> <term><parameter>newval</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetSet</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/setflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/setflags.xml +++ phpdoc/en/reference/spl/cachingiterator/setflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::setFlags</refname> <refpurpose>The setFlags purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::setFlags</methodname> <methodparam><type>bitmask</type><parameter>flags</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> Set the flags for the CachingIterator object. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Bitmask of the flags to set. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </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/cachingiterator/count.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/count.xml +++ phpdoc/en/reference/spl/cachingiterator/count.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::count</refname> <refpurpose>The number of elements in the iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::count</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> May return the number of elements in the iterator. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </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/cachingiterator/key.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/key.xml +++ phpdoc/en/reference/spl/cachingiterator/key.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::key</refname> <refpurpose>Return the key for the current element</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::key</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> This method may return a key for the current element. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </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/cachingiterator/offsetexists.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetexists.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetexists.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetExists</refname> <refpurpose>The offsetExists purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetExists</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetExists</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/getcache.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/getcache.xml +++ phpdoc/en/reference/spl/cachingiterator/getcache.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.getcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::getCache</refname> <refpurpose>The getCache purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getCache</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::getCache</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/getinneriterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml +++ phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.getinneriterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::getInnerIterator</refname> <refpurpose>Return the innter iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getInnerIterator</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> Returns the iterator sent to the constructor. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </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/cachingiterator/valid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/valid.xml diff -u phpdoc/en/reference/spl/cachingiterator/valid.xml:1.4 phpdoc/en/reference/spl/cachingiterator/valid.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/valid.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/valid.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.valid" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::valid</refname> <refpurpose>Check whether the current element is valid</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>CachingIterator::valid</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::valid</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/hasnext.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/hasnext.xml diff -u phpdoc/en/reference/spl/cachingiterator/hasnext.xml:1.4 phpdoc/en/reference/spl/cachingiterator/hasnext.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/hasnext.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/hasnext.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.hasnext" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.hasnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::hasNext</refname> <refpurpose>Check whether the inner iterator has a valid next element</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>CachingIterator::hasNext</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::hasNext</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/rewind.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/rewind.xml diff -u phpdoc/en/reference/spl/cachingiterator/rewind.xml:1.4 phpdoc/en/reference/spl/cachingiterator/rewind.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/rewind.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/rewind.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.rewind" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::rewind</refname> <refpurpose>Rewind the iterator</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>void</type><methodname>CachingIterator::rewind</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::rewind</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/tostring.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/tostring.xml diff -u phpdoc/en/reference/spl/cachingiterator/tostring.xml:1.5 phpdoc/en/reference/spl/cachingiterator/tostring.xml:1.6 --- phpdoc/en/reference/spl/cachingiterator/tostring.xml:1.5 Thu Jun 5 05:03:04 2008 +++ phpdoc/en/reference/spl/cachingiterator/tostring.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> -<refentry xml:id="cachingiterator.tostring" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.6 $ --> + +<refentry xml:id="cachingiterator.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::__toString</refname> <refpurpose>Return the string representation of the current element</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>string</type><methodname>CachingIterator::__toString</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::__toString</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/next.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/next.xml diff -u phpdoc/en/reference/spl/cachingiterator/next.xml:1.4 phpdoc/en/reference/spl/cachingiterator/next.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator/next.xml:1.4 Thu Mar 20 01:25:03 2008 +++ phpdoc/en/reference/spl/cachingiterator/next.xml Fri Nov 14 18:56:21 2008 @@ -1,6 +1,7 @@ -<?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<refentry xml:id="cachingiterator.next" xmlns="http://docbook.org/ns/docbook"> +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.5 $ --> + +<refentry xml:id="cachingiterator.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::next</refname> <refpurpose>Move the iterator forward</refpurpose> @@ -9,8 +10,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>void</type><methodname>CachingIterator::next</methodname> - <void/> + <modifier>public</modifier> <type>void</type><methodname>CachingIterator::next</methodname> + <void /> </methodsynopsis> &warn.undocumented.func; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator.xml diff -u phpdoc/en/reference/spl/cachingiterator.xml:1.4 phpdoc/en/reference/spl/cachingiterator.xml:1.5 --- phpdoc/en/reference/spl/cachingiterator.xml:1.4 Sat Aug 23 14:09:14 2008 +++ phpdoc/en/reference/spl/cachingiterator.xml Fri Nov 14 18:56:21 2008 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.cachingiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>The CachingIterator class</title> <titleabbrev>CachingIterator</titleabbrev> @@ -10,7 +10,7 @@ <section xml:id="cachingiterator.intro"> &reftitle.intro; <para> - ... + This object supports cached iteration over another iterator. </para> </section> <!-- }}} --> @@ -45,46 +45,118 @@ <interfacename>Iterator</interfacename> </oointerface> - <oointerface> + <oointerface> <interfacename>ArrayAccess</interfacename> </oointerface> <oointerface> <interfacename>Countable</interfacename> </oointerface> - </classsynopsisinfo> <!-- }}} --> - - <!-- {{{ If the property is documented below (xml:id=cachingiterator.props) use this - <classsynopsisinfo role="comment">Properties</classsynopsisinfo> + <classsynopsisinfo role="comment">Constants</classsynopsisinfo> <fieldsynopsis> - <modifier>public</modifier> - <type>string</type> - <varname linkend="cachingiterator.props.name">name</varname> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.call-tostring">CachingIterator::CALL_TOSTRING</varname> + <initializer>1</initializer> </fieldsynopsis> - }}} --> - + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.catch-get-child">CachingIterator::CATCH_GET_CHILD</varname> + <initializer>16</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.tostring-use-key">CachingIterator::TOSTRING_USE_KEY</varname> + <initializer>2</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.tostring-use-current">CachingIterator::TOSTRING_USE_CURRENT</varname> + <initializer>4</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.tostring-use-inner">CachingIterator::TOSTRING_USE_INNER</varname> + <initializer>8</initializer> + </fieldsynopsis> + <fieldsynopsis> + <modifier>const</modifier> + <type>integer</type> + <varname linkend="cachingiterator.constants.full-cache">CachingIterator::FULL_CACHE</varname> + <initializer>256</initializer> + </fieldsynopsis> + <classsynopsisinfo role="comment">Methods</classsynopsisinfo> <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> + + <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo> + <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" /> + </classsynopsis> - +<!-- }}} --> + </section> - -<!-- {{{ CachingIterator properties - <section xml:id="cachingiterator.props"> - &reftitle.properties; - <variablelist> - <varlistentry xml:id="cachingiterator.props.name"> - <term><varname>name</varname></term> - <listitem> - <para>Prop description</para> - </listitem> - </varlistentry> - </variablelist> + <!-- {{{ CachingIterator constants --> + <section xml:id="cachingiterator.constants"> + &reftitle.constants; + <section xml:id="cachingiterator.constants.types"> + <title>CachingIterator Node Types</title> + <variablelist> + + <varlistentry xml:id="cachingiterator.constants.call-tostring"> + <term><constant>CachingIterator::CALL_TOSTRING</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.catch-get-child"> + <term><constant>CachingIterator::CATCH_GET_CHILD</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.tostring-use-key"> + <term><constant>CachingIterator::TOSTRING_USE_KEY</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.tostring-use-current"> + <term><constant>CachingIterator::TOSTRING_USE_CURRENT</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.tostring-use-inner"> + <term><constant>CachingIterator::TOSTRING_USE_INNER</constant></term> + <listitem> + <para>Description here...</para> + </listitem> + </varlistentry> + + <varlistentry xml:id="cachingiterator.constants.full-cache"> + <term><constant>CachingIterator::FULL_CACHE</constant></term> + <listitem> + <para>Cache all read data.</para> + </listitem> + </varlistentry> + + </variablelist> + </section> </section> -}}} --> - +<!-- }}} --> + + </partintro> &reference.spl.entities.cachingiterator; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/offsetget.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetget.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetget.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetGet</refname> <refpurpose>The offsetGet purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetGet</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetGet</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/getflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/getflags.xml +++ phpdoc/en/reference/spl/cachingiterator/getflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::getFlags</refname> <refpurpose>Get flags used</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getFlags</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> Get the bitmask of the flags used for this CachingIterator instance. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </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/cachingiterator/current.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/current.xml +++ phpdoc/en/reference/spl/cachingiterator/current.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::current</refname> <refpurpose>Return the current element</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::current</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> May return the current element in the iteration. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Mixed </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Iterator::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/cachingiterator/construct.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/construct.xml +++ phpdoc/en/reference/spl/cachingiterator/construct.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::__construct</refname> <refpurpose>Construct a new CachingIterator object for the iterator.</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <methodname>CachingIterator::__construct</methodname> <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>iterator</parameter></term> <listitem> <para> Iterator to cache </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Bitmask of flags. </para> </listitem> </varlistentry> </variablelist> </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/cachingiterator/offsetunset.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetunset.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetunset.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetUnset</refname> <refpurpose>The offsetUnset purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetUnset</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetUnset</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/offsetset.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetset.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetset.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetSet</refname> <refpurpose>The offsetSet purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetSet</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> <methodparam><type>string</type><parameter>newval</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> <varlistentry> <term><parameter>newval</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetSet</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/setflags.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/setflags.xml +++ phpdoc/en/reference/spl/cachingiterator/setflags.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::setFlags</refname> <refpurpose>The setFlags purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::setFlags</methodname> <methodparam><type>bitmask</type><parameter>flags</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> Set the flags for the CachingIterator object. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> Bitmask of the flags to set. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.void; </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/cachingiterator/count.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/count.xml +++ phpdoc/en/reference/spl/cachingiterator/count.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::count</refname> <refpurpose>The number of elements in the iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::count</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> May return the number of elements in the iterator. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </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/cachingiterator/key.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/key.xml +++ phpdoc/en/reference/spl/cachingiterator/key.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::key</refname> <refpurpose>Return the key for the current element</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::key</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> This method may return a key for the current element. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </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/cachingiterator/offsetexists.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/offsetexists.xml +++ phpdoc/en/reference/spl/cachingiterator/offsetexists.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::offsetExists</refname> <refpurpose>The offsetExists purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetExists</methodname> <methodparam><type>string</type><parameter>index</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>index</parameter></term> <listitem> <para> Description... </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::offsetExists</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/getcache.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/getcache.xml +++ phpdoc/en/reference/spl/cachingiterator/getcache.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.getcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::getCache</refname> <refpurpose>The getCache purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getCache</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> The method description goes here. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>CachingIterator::getCache</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* ... */ ?> ]]> </programlisting> &example.outputs.similar; <screen> <![CDATA[.... ]]> </screen> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><methodname>Classname::Method</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/cachingiterator/getinneriterator.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml +++ phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml <?xml version="1.0" encoding="utf-8"?> <!-- $Revision: 1.1 $ --> <refentry xml:id="cachingiterator.getinneriterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CachingIterator::getInnerIterator</refname> <refpurpose>Return the innter iterator</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CachingIterator::getInnerIterator</methodname> <void /> </methodsynopsis> &warn.undocumented.func; <para> Returns the iterator sent to the constructor. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Description... </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 -->