cvs: phpdoc /en/language/predefined traversable.xml
| From: | Hannes Magnusson | Date: | Fri, 14 Nov 2008 19:11:11 +0000 |
| Subject: | cvs: phpdoc /en/language/predefined traversable.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2531@lists.php.net to get a copy of this message | ||
bjori Fri Nov 14 19:11:11 2008 UTC
Added files:
/phpdoc/en/language/predefined traversable.xml
Log:
Initial commit
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/predefined/traversable.xml?view=markup&rev=1.1
Index: phpdoc/en/language/predefined/traversable.xml
+++ phpdoc/en/language/predefined/traversable.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.traversable" 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 Traversable class</title>
<titleabbrev>Traversable</titleabbrev>
<partintro>
<!-- {{{ Traversable intro -->
<section xml:id="traversable.intro">
&reftitle.intro;
<para>
Interface to detect if a class is traversable using
<function>foreach</function>.
</para>
<para>
Abstract base interface that cannot be implemented alone. Instead it must
be implemented by either <classname>IteratorAggregate</classname> or
<classname>Iterator</classname>.
</para>
<note>
<para>
Internal (built-in) classes that implement this interface can be used in
a <function>foreach</function> construct and do not need to implement
<classname>IteratorAggregate</classname> or
<classname>Iterator</classname>.
</para>
</note>
<note>
<para>
This is an internal engine interface which cannot be implemented in PHP
scripts. Either <classname>IteratorAggregate</classname> or
<classname>Iterator</classname> must be used instead.
</para>
</note>
</section>
<!-- }}} -->
<section xml:id="traversable.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>Traversable</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>Traversable</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
</classsynopsis>
<!-- }}} -->
<para>
This interface has no methods, its only purpose is to be the base
interface for all traversable classes.
</para>
</section>
</partintro>
</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
-->