isvalid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="xmlreader.isvalid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>XMLReader::isValid</refname>
  <refpurpose>Indicates if the parsed document is valid</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="XMLReader">
   <modifier>public</modifier> <type>bool</type><methodname>XMLReader::isValid</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Returns a boolean indicating if the document being parsed is currently valid according to the DTD, or an XML or RelaxNG schema.
   If there there is no schema, and the DTD validation option is not provided, this method will return &false;.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; when the document is valid or &false; otherwise.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Validating XML</title>
    <programlisting role="php">
<![CDATA[
<?php
$xml = XMLReader::open('test.xml');

// The validate parser option must be enabled for 
// this method to work properly
$xml->setParserProperty(XMLReader::VALIDATE, true);

var_dump($xml->isValid());
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    This checks the current node, not the entire document.
   </simpara>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>XMLReader::setParserProperty</methodname></member>
    <member><methodname>XMLReader::setRelaxNGSchema</methodname></member>
    <member><methodname>XMLReader::setRelaxNGSchemaSource</methodname></member>
    <member><methodname>XMLReader::setSchema</methodname></member>
   </simplelist>
  </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
-->