mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
675628feac
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165780 c90b9560-bf6c-de11-be94-00142212c4b1
85 lines
2.8 KiB
XML
85 lines
2.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<!-- splitted from ./en/functions/domxml.xml, last change in rev 1.1 -->
|
|
<refentry id="function.domxml-open-file">
|
|
<refnamediv>
|
|
<refname>domxml_open_file</refname>
|
|
<refpurpose>Creates a DOM object from XML file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>object</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>&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.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Opening an XML document from a file</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
if (!$dom = domxml_open_file("example.xml")) {
|
|
echo "Error while parsing the document\n";
|
|
exit;
|
|
}
|
|
|
|
$root = $dom->document_element();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>domxml_open_mem</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
|
|
-->
|