Initial commit

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269013 c90b9560-bf6c-de11-be94-00142212c4b1

language/predefined/traversable.xml

@@ -0,0 +1,90 @@
+<?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
+-->
+