didou Fri Jun 17 19:35:55 2005 EDT
Modified files:
/phpdoc/en/reference/domxml/functions domxml-new-doc.xml
domxml-open-file.xml
domxml-open-mem.xml
domxml-version.xml
domxml-xmltree.xml
domxml-xslt-stylesheet-doc.xml
domxml-xslt-stylesheet-file.xml
domxml-xslt-stylesheet.xml
Log:
Switch to the new format
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-new-doc.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-new-doc.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-new-doc.xml:1.8
phpdoc/en/reference/domxml/functions/domxml-new-doc.xml:1.9
--- phpdoc/en/reference/domxml/functions/domxml-new-doc.xml:1.8 Fri Jun 17
19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-new-doc.xml Fri Jun 17
19:35:55 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<refentry id="function.domxml-new-doc">
<refnamediv>
<refname>domxml_new_doc</refname>
@@ -7,14 +7,35 @@
Creates new empty XML document
</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>domdocument</type><methodname>domxml_new_doc</methodname>
+ <type>DomDocument</type><methodname>domxml_new_doc</methodname>
<methodparam><type>string</type><parameter>version</parameter></methodparam>
</methodsynopsis>
<para>
- Creates a new dom document from scratch and returns it.
+ Creates a new Dom document from scratch and returns it.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>version</parameter></term>
+ <listitem>
+ <para>
+ The XML version number of the document.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a new <classname>DomDocument</classname> instance.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-open-file.xml?r1=1.11&r2=1.12&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-open-file.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-open-file.xml:1.11
phpdoc/en/reference/domxml/functions/domxml-open-file.xml:1.12
--- phpdoc/en/reference/domxml/functions/domxml-open-file.xml:1.11 Fri Jun
17 19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-open-file.xml Fri Jun 17
19:35:55 2005
@@ -1,42 +1,74 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<refentry id="function.domxml-open-file">
<refnamediv>
<refname>domxml_open_file</refname>
- <refpurpose>Creates a DOM object from XML file</refpurpose>
+ <refpurpose>Creates a DOM object from an XML file</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>domdocument</type><methodname>domxml_open_file</methodname>
+ <type>DomDocument</type><methodname>domxml_open_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter
role="reference">error</parameter></methodparam>
</methodsynopsis>
<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 as listed above.
- The file is accessed read-only.
- </para>
- <para>
- Optional parameter <parameter>mode</parameter> can be used to change the
- behavior of this function. It was added in PHP 4.3.0. You can use one of
- the following constants for it:
- <constant>DOMXML_LOAD_PARSING</constant> (default),
- <constant>DOMXML_LOAD_VALIDATING</constant> or
- <constant>DOMXML_LOAD_RECOVERING</constant>.
- You can add to it also <constant>DOMXML_LOAD_DONT_KEEP_BLANKS</constant>,
- <constant>DOMXML_LOAD_SUBSTITUTE_ENTITIES</constant> and
- <constant>DOMXML_LOAD_COMPLETE_ATTRS</constant> by
- <link linkend="language.operators.bitwise">bitwise or</link>.
- </para>
- <para>
- If the <parameter>error</parameter> parameter is used, it will contain the
- error messages. <parameter>error</parameter> must be passed in by
- <link linkend="language.references">reference</link>. The parameter was
- added in PHP 4.3.0.
+ The function parses the XML document in the given file.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The path to the XML file. The file is accessed in read-only mode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ This optional parameter can be used to change the behavior of this
+ function.
+ </para>
+ <para>
+ You can use one of the following constants for it:
+ <constant>DOMXML_LOAD_PARSING</constant> (default),
+ <constant>DOMXML_LOAD_VALIDATING</constant> or
+ <constant>DOMXML_LOAD_RECOVERING</constant>.
+ You can add to it also
<constant>DOMXML_LOAD_DONT_KEEP_BLANKS</constant>,
+ <constant>DOMXML_LOAD_SUBSTITUTE_ENTITIES</constant> and
+ <constant>DOMXML_LOAD_COMPLETE_ATTRS</constant> by
+ <link linkend="language.operators.bitwise">bitwise or</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>error</parameter></term>
+ <listitem>
+ <para>
+ If used, it will contain the error messages.
+ <parameter>error</parameter> must be passed in by <link
+ linkend="language.references">reference</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <classname>DomDocument</classname> instance of the given file.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Opening an XML document from a file</title>
@@ -55,9 +87,38 @@
</programlisting>
</example>
</para>
+ </refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>4.3.0</entry>
+ <entry>
+ The parameters <parameter>mode</parameter> and
+ <parameter>error</parameter> were added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>domxml_open_mem</function>, and
- <function>domxml_new_doc</function>.
+ <simplelist>
+ <member><function>domxml_open_mem</function></member>
+ <member><function>domxml_new_doc</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-open-mem.xml?r1=1.10&r2=1.11&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-open-mem.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-open-mem.xml:1.10
phpdoc/en/reference/domxml/functions/domxml-open-mem.xml:1.11
--- phpdoc/en/reference/domxml/functions/domxml-open-mem.xml:1.10 Fri Jun
17 19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-open-mem.xml Fri Jun 17
19:35:55 2005
@@ -1,36 +1,75 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry id="function.domxml-open-mem">
<refnamediv>
<refname>domxml_open_mem</refname>
<refpurpose>Creates a DOM object of an XML document</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>domdocument</type><methodname>domxml_open_mem</methodname>
+ <type>DomDocument</type><methodname>domxml_open_mem</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter
role="reference">error</parameter></methodparam>
</methodsynopsis>
<para>
- The function parses the XML document in
- <parameter>str</parameter> and returns an object of class "Dom
- document", having the properties as listed above. This function,
- <function>domxml_open_file</function> or <function>domxml_new_doc</function>
- must be called before any other function calls.
+ The function parses the XML document in the given string.
</para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- Optional parameter <parameter>mode</parameter> can be used to change the
- behavior of this function. It was added in PHP 4.3.0. See
- <function>domxml_open_file</function> for possible values.
+ <variablelist>
+ <varlistentry>
+ <term><parameter>str</parameter></term>
+ <listitem>
+ <para>
+ The contents of the XML file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ This optional parameter can be used to change the behavior of this
+ function.
+ </para>
+ <para>
+ You can use one of the following constants for it:
+ <constant>DOMXML_LOAD_PARSING</constant> (default),
+ <constant>DOMXML_LOAD_VALIDATING</constant> or
+ <constant>DOMXML_LOAD_RECOVERING</constant>.
+ You can add to it also
<constant>DOMXML_LOAD_DONT_KEEP_BLANKS</constant>,
+ <constant>DOMXML_LOAD_SUBSTITUTE_ENTITIES</constant> and
+ <constant>DOMXML_LOAD_COMPLETE_ATTRS</constant> by
+ <link linkend="language.operators.bitwise">bitwise or</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>error</parameter></term>
+ <listitem>
+ <para>
+ If used, it will contain the error messages.
+ <parameter>error</parameter> must be passed in by <link
+ linkend="language.references">reference</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- If the <parameter>error</parameter> parameter is used, it will contain the
- error messages. <parameter>error</parameter> must be passed in by
- <link linkend="language.references">reference</link>. The parameter was
- added in PHP 4.3.0.
+ Returns a <classname>DomDocument</classname> instance of the given XML
+ contents.
</para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Opening an XML document in a string</title>
@@ -50,9 +89,14 @@
</programlisting>
</example>
</para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>domxml_open_file</function>, and
- <function>domxml_new_doc</function>.
+ <simplelist>
+ <member><function>domxml_open_file</function></member>
+ <member><function>domxml_new_doc</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-version.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-version.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-version.xml:1.5
phpdoc/en/reference/domxml/functions/domxml-version.xml:1.6
--- phpdoc/en/reference/domxml/functions/domxml-version.xml:1.5 Fri Jun 17
19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-version.xml Fri Jun 17
19:35:55 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id='function.domxml-version'>
<refnamediv>
<refname>domxml_version</refname>
@@ -7,16 +7,24 @@
Gets the XML library version
</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>domxml_version</methodname>
<void/>
</methodsynopsis>
<para>
- This function returns the version of the version of the XML library
- currently used.
+ Gets the version of the XML library currently used.
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The version of the XML library, as a string.
+ </para>
+ </refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>domxml_version</function> Example</title>
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xmltree.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-xmltree.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-xmltree.xml:1.6
phpdoc/en/reference/domxml/functions/domxml-xmltree.xml:1.7
--- phpdoc/en/reference/domxml/functions/domxml-xmltree.xml:1.6 Fri Jun 17
19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-xmltree.xml Fri Jun 17
19:35:55 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<refentry id="function.domxml-xmltree">
<refnamediv>
<refname>domxml_xmltree</refname>
@@ -7,23 +7,49 @@
Creates a tree of PHP objects from an XML document
</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>domdocument</type><methodname>domxml_xmltree</methodname>
+ <type>DomDocument</type><methodname>domxml_xmltree</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
The function parses the XML document in <parameter>str</parameter> and
- returns a tree PHP objects as the parsed document. This function is
- isolated from the other functions, which means you cannot access the tree
- with any of the other functions.
+ returns a tree PHP objects as the parsed document.
+ </para>
+ <para>
+ This function is isolated from the other functions, which means you cannot
+ access the tree with any of the other functions.
Modifying it, for example by adding nodes, makes no sense since there
is currently no way to dump it as an XML file.
+ </para>
+ <para>
However this function may be valuable if you want to read a file and
investigate the content.
</para>
</refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>str</parameter></term>
+ <listitem>
+ <para>
+ The contents of the XML file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a tree of Dom objects starting by a
+ <classname>DomDocument</classname>.
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml:1.9
phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml:1.10
--- phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml:1.9
Fri Jun 17 19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-doc.xml Fri Jun
17 19:35:55 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<refentry id="function.domxml-xslt-stylesheet-doc">
<refnamediv>
<refname>domxml_xslt_stylesheet_doc</refname>
@@ -7,7 +7,7 @@
Creates a DomXsltStylesheet Object from a DomDocument Object
</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>XsltStylesheet</type><methodname>domxml_xslt_stylesheet_doc</methodname>
@@ -16,10 +16,15 @@
&warn.undocumented.func;
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>domxsltstylesheet->process</function>,
- <function>domxml_xslt_stylesheet</function>, and
- <function>domxml_xslt_stylesheet_file</function>.
+ <simplelist>
+ <member><function>domxsltstylesheet->process</function></member>
+ <member><function>domxml_xslt_stylesheet</function></member>
+ <member><function>domxml_xslt_stylesheet_file</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml?r1=1.10&r2=1.11&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml
diff -u
phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml:1.10
phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml:1.11
--- phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml:1.10
Fri Jun 17 19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet-file.xml
Fri Jun 17 19:35:55 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry id="function.domxml-xslt-stylesheet-file">
<refnamediv>
<refname>domxml_xslt_stylesheet_file</refname>
@@ -7,7 +7,7 @@
Creates a DomXsltStylesheet Object from an XSL document in a file
</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>XsltStylesheet</type><methodname>domxml_xslt_stylesheet_file</methodname>
@@ -16,10 +16,15 @@
&warn.undocumented.func;
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>domxsltstylesheet->process</function>,
- <function>domxml_xslt_stylesheet</function>, and
- <function>domxml_xslt_stylesheet_doc</function>
+ <simplelist>
+ <member><function>domxsltstylesheet->process</function></member>
+ <member><function>domxml_xslt_stylesheet</function></member>
+ <member><function>domxml_xslt_stylesheet_doc</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml?r1=1.10&r2=1.11&ty=u
Index: phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml
diff -u phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml:1.10
phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml:1.11
--- phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml:1.10
Fri Jun 17 19:35:37 2005
+++ phpdoc/en/reference/domxml/functions/domxml-xslt-stylesheet.xml Fri Jun
17 19:35:55 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry id="function.domxml-xslt-stylesheet">
<refnamediv>
<refname>domxml_xslt_stylesheet</refname>
@@ -7,7 +7,7 @@
Creates a DomXsltStylesheet Object from an XML document in a string
</refpurpose>
</refnamediv>
- <refsect1>
+ <refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>XsltStylesheet</type><methodname>domxml_xslt_stylesheet</methodname>
@@ -16,10 +16,15 @@
&warn.undocumented.func;
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>domxsltstylesheet->process</function>,
- <function>domxml_xslt_stylesheet_file</function>, and
- <function>domxml_xslt_stylesheet_doc</function>
+ <simplelist>
+ <member><function>domxsltstylesheet->process</function></member>
+ <member><function>domxml_xslt_stylesheet_file</function></member>
+ <member><function>domxml_xslt_stylesheet_doc</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
