debian man page for xml::validate::libxml

XML::Validate::LibXML(3pm)				User Contributed Perl Documentation				XML::Validate::LibXML(3pm)

NAME
       XML::Validate::LibXML - Interface to LibXML validator

SYNOPSIS
	 my $validator = new XML::Validate::LibXML(%options);
	 if ($doc = $validator->validate($xml)) {
	   ... Do stuff with $doc ...
	 } else {
	   print "Document is invalid
";
	 }

DESCRIPTION
       XML::Validate::LibXML is an interface to the LibXML validating parser which can be used with the XML::Validate module.

METHODS
       new(%options)
	   Returns a new XML::Validate::LibXML instance using the specified options. (See OPTIONS below.)

       validate($xml)
	   Returns a true value if $xml could be successfully parsed, undef otherwise.

	   Returns a true (XML::LibXML::Document) if $xml could be successfully parsed, undef otherwise.

       last_dom()
	   Returns the DOM (XML::LibXML::Document) of the document last validated.

       last_error()
	   Returns a hash ref containing the error from the last validate call. This backend currently only fills in the message field of hash.
	   Note that the error gets cleared at the beginning of each "validate" call.

       version()
	   Returns the version of the XML::LibXML module that is installed

OPTIONS
       XML::Validate::LibXML takes the following options:

       strict_validation
	   If this boolean value is true, the document will be validated during parsing.  Otherwise it will only be checked for well-formedness.
	   Defaults to true.

       base_uri
	   Since the XML document is supplied as a string, the validator doesn't know the document's URI. If the document contains any components
	   referenced using relative URI's, you'll need to set this option to the document's URI so that the validator can retrieve them
	   correctly.

ERROR REPORTING
       When a call to validate fails to parse the document, the error may be retrieved using last_error.

       On errors not related to the XML parsing, these methods will throw exceptions.  Wrap calls with eval to catch them.

DEPENDENCIES
       XML::LibXML

BUGS
       last_error currently returns a hash ref with only the message field filled. It would be nice to also fill the line and column fields.

VERSION
       $Revision: 1.20 $ on $Date: 2005/09/06 11:05:08 $ by $Author: johna $

AUTHOR
       Nathan Carr, Colin Robertson

       <cpan _at_ bbc _dot_ co _dot_ uk>

COPYRIGHT
       (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL.  See the file COPYING in this
       distribution, or http://www.gnu.org/licenses/gpl.txt

perl v5.10.1							    2006-04-19						XML::Validate::LibXML(3pm)