From 8c63df0722bc8003d216d4cd113cc599d878f245 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kristian=20K=C3=B6hntopp?= <kk@php.net>
Date: Fri, 3 Mar 2000 22:48:08 +0000
Subject: [PATCH] first stab at domxml module documentation.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@20914 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/domxml.xml | 266 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 266 insertions(+)
 create mode 100644 functions/domxml.xml

diff --git a/functions/domxml.xml b/functions/domxml.xml
new file mode 100644
index 0000000000..bbcc0aa81a
--- /dev/null
+++ b/functions/domxml.xml
@@ -0,0 +1,266 @@
+ <reference id="ref.bc">
+  <title>DOM XML functions</title>
+  <titleabbrev>DOM XML</titleabbrev>
+
+  <partintro>
+  <simpara>
+    These functions are only available if PHP was configured with
+    <option role="configure">--with-dom=[DIR]</option>, using the
+    GNOME xml library. These functions have been added in PHP4.
+  </simpara>
+
+  <simpara>
+   This module defines the following constants:
+   <table>
+    <title>XML constants</title>
+    <tgroup cols="3">
+     <thead>
+      <row>
+       <entry>Constant</entry>
+       <entry>Value</entry>
+       <entry>Description</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>XML_ELEMENT_NODE</entry>
+       <entry>1</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_ATTRIBUTE_NODE</entry>
+       <entry>2</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_TEXT_NODE</entry>
+       <entry>3</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_CDATA_SECTION_NODE</entry>
+       <entry>4</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_ENTITY_REF_NODE</entry>
+       <entry>5</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_ENTITY_NODE</entry>
+       <entry>6</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_PI_NODE</entry>
+       <entry>7</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_COMMENT_NODE</entry>
+       <entry>8</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_DOCUMENT_NODE</entry>
+       <entry>9</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_DOCUMENT_TYPE_NODE</entry>
+       <entry>10</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_DOCUMENT_FRAG_NODE</entry>
+       <entry>11</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_NOTATION_NODE</entry>
+       <entry>12</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_GLOBAL_NAMESPACE</entry>
+       <entry>1</entry>
+       <entry></entry>
+      </row>
+      <row>
+       <entry>XML_LOCAL_NAMESPACE</entry>
+       <entry>2</entry>
+       <entry></entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </table>
+  </simpara>
+
+  <simpara>This module defines a number of classes. The DOM XML
+   functions return a parsed tree of the XML document with
+   each node being an object belonging to one of these classes.
+
+  <!-- class Dom document -->
+  <!-- has member functions
+        array root([int doc_handle]) 
+           returns array of root nodes of this document. Array
+           elements are objects of class "Dom node" having properties of
+           "node" (resource), "type" (long), "name" (string)
+           and optionally "content" (string).
+
+        array children([ int node ])
+           returns an array of child nodes of this element. Array
+           elements are objects of class "Dom node" having properties
+           of "node" (resource), "type" (long), "name" (string)
+           and optionally "content" (string).
+
+        object add_root([int doc_handle,] string name)
+           Add a root node to document.
+
+           returns an object of class "Dom node" having properties
+           of "node" (resource), "type" (long), "name" (string)
+           and optionally "content" (string). 
+
+        object intdtd([int doc_handle])
+           returns the DTD of document.
+
+           returns an object of class "Dtd" having properties
+           of "dtd" (resource), "sysid" (string), "name" (string)
+           and optionally "extid" (string).
+
+        string dumpmem([int doc_handle])
+           dumps document into string.
+    -->
+
+   <!-- class Dom node
+        object lastchild([int node])
+          returns Dom node object
+
+        array children([int node])
+          as above
+
+        object parent([ int node])
+          returns Dom node object
+          (parent of this node)
+
+        new_child
+        string getattr([int node,] string attrname)
+          get value of attribute named attrname
+
+        bool setattr([int node,] string attrname, string value)
+          set value of given attribute.
+
+        array attributes([int node])
+          returns associative array of (string name, string value)
+          pairs.
+
+        object node(string name)
+          creates a named Dom node object.
+    -->
+
+  <!-- class Dom Attribute
+       name
+    -->
+
+  <!-- class Dom Namespace
+    -->
+
+  <!-- class Dtd
+    -->        
+  </simpara>
+
+  </partintro>
+
+  <refentry id="function.xmldoc">
+   <refnamediv>
+    <refname>xmldoc</refname>
+    <refpurpose>Creates a DOM object of an XML document</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcdef>object <function>xmldoc</function></funcdef>
+     <paramdef>string <parameter>str</parameter></paramdef>
+    </funcsynopsis>
+    <para>
+     The function parses the XML document in
+     <parameter>str</parameter> and returns an object of class
+     "Dom document", having the properties "doc" (resource),
+     "version" (string) and "type" (long).
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.xmldocfile">
+   <refnamediv>
+    <refname>xmldocfile</refname>
+    <refpurpose>Creates a DOM object from XML file</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcdef>object <function>xmldocfile</function></funcdef>
+     <paramdef>string <parameter>filename</parameter></paramdef>
+    </funcsynopsis>
+    <para>
+     The function parses the XML document in the file named
+     <parameter>filename</parameter> and returns an object of class
+     "Dom document", having the properties "doc" (resource),
+     "version" (string).
+
+     <!-- conspiciously the file attribute is missing? -->
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.xmltree">
+   <refnamediv>
+    <refname>xmltree</refname>
+    <refpurpose>Creates a tree of php objects from XML document</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcdef>object <function>xmltree</function></funcdef>
+     <paramdef>string <parameter>str</parameter></paramdef>
+    </funcsynopsis>
+    <para>
+     The function parses the XML document in
+     <parameter>str</parameter> and returns a tree PHP objects
+     as the parsed document.
+    </para>
+   </refsect1>
+  </refentry>
+
+ <!--
+   TODO
+
+   domxml_root
+   domxml_add_root
+   domxml_dumpmem
+   domxml_attributes
+   domxml_getattr
+   domxml_setattr
+   domxml_children
+   domxml_new_child
+   domxml_node
+   domxml_new_xmldoc alias new_xmldoc
+ </reference>
+
+<!-- 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
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->