php-doc-en/reference/domxml/functions/domxml-xmltree.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

74 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.domxml-xmltree" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>domxml_xmltree</refname>
<refpurpose>
Creates a tree of PHP objects from an XML document
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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.
</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
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:"~/.phpdoc/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
-->