libxmlerror.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref
 xmlns:phpdoc="http://php.net/ns/phpdoc"
 xml:id="class.libxmlerror"
 xmlns="http://docbook.org/ns/docbook"
 xmlns:xlink="http://www.w3.org/1999/xlink"
 xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The LibXMLError class</title>
 <titleabbrev>LibXMLError</titleabbrev>
 
 <partintro>
 
<!-- {{{ LibXMLError intro -->
  <section xml:id="libxmlerror.intro">
   &reftitle.intro;
   <para>
    Contains various information about errors thrown by libxml. The error codes
    are described within the official 
    <link xlink:href="&url.libxml.errorcodes;">xmlError API documentation</link>.
   </para>

  </section>
<!-- }}} -->
 
  <section xml:id="libxmlerror.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>LibXMLError</classname></ooclass>
 
<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>LibXMLError</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
 
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="libxmlerror.props.level">level</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="libxmlerror.props.code">code</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="libxmlerror.props.column">column</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="libxmlerror.props.message">message</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="libxmlerror.props.file">file</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="libxmlerror.props.line">line</varname>
    </fieldsynopsis>
   </classsynopsis>
<!-- }}} -->
  </section>
 
<!-- {{{ libXMLError properties -->
  <section xml:id="libxmlerror.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="libxmlerror.props.level">
     <term><varname>level</varname></term>
     <listitem>
      <para>
       the severity of the error (one of the following constants:
       <constant>LIBXML_ERR_WARNING</constant>,
       <constant>LIBXML_ERR_ERROR</constant> or
       <constant>LIBXML_ERR_FATAL</constant>)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="libxmlerror.props.code">
     <term><varname>code</varname></term>
     <listitem>
      <para>
       The error's code.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="libxmlerror.props.column">
     <term><varname>column</varname></term>
     <listitem>
      <para>
       The column where the error occurred.
      </para>
      <note>
       <para>
        This property isn't entirely implemented in libxml and therefore
        <literal>0</literal> is often returned.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="libxmlerror.props.message">
     <term><varname>message</varname></term>
     <listitem>
      <para>
       The error message, if any.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="libxmlerror.props.file">
     <term><varname>file</varname></term>
     <listitem>
      <para>The filename, or empty if the XML was loaded from a string.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="libxmlerror.props.line">
     <term><varname>line</varname></term>
     <listitem>
      <para>
       The line where the error occurred.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->
 
 </partintro>
 
</phpdoc:classref>
 
<!-- 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
-->