.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "XML::Validate::LibXML 3pm"
.TH XML::Validate::LibXML 3pm "2022-06-28" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
XML::Validate::LibXML \- Interface to LibXML validator
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  my $validator = new XML::Validate::LibXML(%options);
\&  if ($doc = $validator\->validate($xml)) {
\&    ... Do stuff with $doc ...
\&  } else {
\&    print "Document is invalid\en";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
XML::Validate::LibXML is an interface to the LibXML validating parser which can
be used with the XML::Validate module.
.SH "METHODS"
.IX Header "METHODS"
.IP "new(%options)" 4
.IX Item "new(%options)"
Returns a new XML::Validate::LibXML instance using the specified options. (See
\&\s-1OPTIONS\s0 below.)
.IP "validate($xml)" 4
.IX Item "validate($xml)"
Returns a true value if \f(CW$xml\fR could be successfully parsed, undef otherwise.
.Sp
Returns a true (XML::LibXML::Document) if \f(CW$xml\fR could be successfully
parsed, undef otherwise.
.IP "\fBlast_dom()\fR" 4
.IX Item "last_dom()"
Returns the \s-1DOM\s0 (XML::LibXML::Document) of the document last validated.
.IP "\fBlast_error()\fR" 4
.IX Item "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 \f(CW\*(C`validate\*(C'\fR call.
.IP "\fBversion()\fR" 4
.IX Item "version()"
Returns the version of the XML::LibXML module that is installed
.SH "OPTIONS"
.IX Header "OPTIONS"
XML::Validate::LibXML takes the following options:
.IP "strict_validation" 4
.IX Item "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.
.IP "base_uri" 4
.IX Item "base_uri"
Since the \s-1XML\s0 document is supplied as a string, the validator doesn't know the
document's \s-1URI.\s0 If the document contains any components referenced using
relative \s-1URI\s0's, you'll need to set this option to the document's \s-1URI\s0 so that
the validator can retrieve them correctly.
.SH "ERROR REPORTING"
.IX Header "ERROR REPORTING"
When a call to validate fails to parse the document, the error may be retrieved using last_error.
.PP
On errors not related to the \s-1XML\s0 parsing, these methods will throw exceptions.
Wrap calls with eval to catch them.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
XML::LibXML
.SH "BUGS"
.IX Header "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.
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Revision:\fR 1.20 $ on \f(CW$Date:\fR 2005/09/06 11:05:08 $ by \f(CW$Author:\fR johna $
.SH "AUTHOR"
.IX Header "AUTHOR"
Nathan Carr, Colin Robertson
.PP
<cpan _at_ bbc _dot_ co _dot_ uk>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
(c) \s-1BBC 2005.\s0 This program is free software; you can redistribute it and/or modify it under the \s-1GNU GPL.\s0
See the file \s-1COPYING\s0 in this distribution, or http://www.gnu.org/licenses/gpl.txt