php-doc-en/reference/simplexml/functions/simplexml-load-file.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
  <refentry id='function.simplexml-load-file'>
   <refnamediv>
    <refname>simplexml_load_file</refname>
    <refpurpose>
     Interprets an XML file into an object
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>object</type><methodname>simplexml_load_file</methodname>
     <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     <methodparam choice="opt"><type>string</type><parameter>class_name</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
    </methodsynopsis>
    <para>
     This function will convert the well-formed XML document in the file
     specified by <parameter>filename</parameter> to an <type>object</type>
     of class <type>SimpleXMLElement</type>. If any errors occur during file
     access or interpretation, the function returns &false;.
    </para>
    <para>
     You may use the optional <parameter>class_name</parameter> parameter so
     that <function>simplexml_load_file</function> will return an object of
     the specified class. That class should extend the
     <type>SimpleXMLElement</type> class.
    </para>
    <para>
     Since PHP 5.1.0 and Libxml 2.6.0, you may also use the
     <parameter>options</parameter> parameter to specify <link
      linkend="libxml.constants">additional Libxml parameters</link>.
    </para>
    <para>
     <example>
      <title>Interpret an XML document</title>
      <programlisting role="php">
<![CDATA[
<?php
// The file test.xml contains an XML document with a root element
// and at least an element /[root]/title.

if (file_exists('test.xml')) {
    $xml = simplexml_load_file('test.xml');
 
    var_dump($xml);
} else {
    exit('Failed to open test.xml.');
}
?>
]]>
      </programlisting>
      <para>
       This script will display, on success:
      </para>
      <screen>
<![CDATA[
SimpleXMLElement Object
(
  [title] => Example Title
  ...
)
]]>
      </screen>
      <simpara>
       At this point, you can go about using <literal>$xml->title</literal>
       and any other elements.
      </simpara>
     </example>
    </para>
    <para>
     See also: <function>simplexml_load_string</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
-->