php-doc-en/reference/domxml/functions/domxml-open-mem.xml
Jakub Vrana 51c248a7d2 Mode parameter (bug #24722)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165650 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-07 16:18:12 +00:00

80 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/domxml.xml, last change in rev 1.1 -->
<refentry id="function.domxml-open-mem">
<refnamediv>
<refname>domxml_open_mem</refname>
<refpurpose>Creates a DOM object of an XML document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</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>&amp;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.
</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. See
<function>domxml_open_file</function> for possible values.
</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.
</para>
<para>
<example>
<title>Opening an XML document in a string</title>
<programlisting role="php">
<![CDATA[
<?php
include("example.inc");
if (!$dom = domxml_open_mem($xmlstr)) {
echo "Error while parsing the document\n";
exit;
}
$root = $dom->document_element();
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>domxml_open_file</function>, and
<function>domxml_new_doc</function>.
</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:"../../../../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
-->