#
# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
=head1 NAME
my $output = $xslt_engine->transform($xml, $xsltfilename);
$output = $xslt_engine->transform({ xml => $xml, file => $file });
$output = $xslt_engine->transform({ xml => $xml, code => $code });
- my $err= $xslt_engine->err; # error number
- my $errstr= $xslt_engine->errstr; # error message
+ my $err= $xslt_engine->err; # error code
$xslt_engine->refresh($xsltfilename);
=head1 DESCRIPTION
A XSLT handler object on top of LibXML and LibXSLT, allowing you to
run XSLT stylesheets repeatedly without loading them again.
Errors occurring during loading, parsing or transforming are reported
- via the err and errstr attributes.
+ via the err attribute.
Reloading XSLT files can be done with the refresh method.
=head1 METHODS
=head2 err
- Error number (see list of ERROR CODES)
-
-=head2 errstr
-
- Error message
+ Error code (see list of ERROR CODES)
=head2 do_not_return_source
=head2 print_warns
- If set, print error messages to STDERR. True by default.
+ If set, print error messages to STDERR. False by default. Looks at the
+ DEBUG environment variable too.
=head1 ERROR CODES
-=head2 Error 1
+=head2 Error XSLTH_ERR_NO_FILE
No XSLT file passed
-=head2 Error 2
+=head2 Error XSLTH_ERR_FILE_NOT_FOUND
XSLT file not found
-=head2 Error 3
+=head2 Error XSLTH_ERR_LOADING
- Error while loading stylesheet xml: [furter information]
+ Error while loading stylesheet xml: [optional warnings]
-=head2 Error 4
+=head2 Error XSLTH_ERR_PARSING_CODE
- Error while parsing stylesheet: [furter information]
+ Error while parsing stylesheet: [optional warnings]
-=head2 Error 5
+=head2 Error XSLTH_ERR_PARSING_DATA
- Error while parsing input: [furter information]
+ Error while parsing input: [optional warnings]
-=head2 Error 6
+=head2 Error XSLTH_ERR_TRANSFORMING
- Error while transforming input: [furter information]
+ Error while transforming input: [optional warnings]
-=head2 Error 7
+=head2 Error XSLTH_NO_STRING_PASSED
No string to transform
use base qw(Class::Accessor);
-__PACKAGE__->mk_ro_accessors(qw( err errstr ));
+__PACKAGE__->mk_ro_accessors(qw( err ));
__PACKAGE__->mk_accessors(qw( do_not_return_source print_warns ));
+use constant XSLTH_ERR_1 => 'XSLTH_ERR_NO_FILE';
+use constant XSLTH_ERR_2 => 'XSLTH_ERR_FILE_NOT_FOUND';
+use constant XSLTH_ERR_3 => 'XSLTH_ERR_LOADING';
+use constant XSLTH_ERR_4 => 'XSLTH_ERR_PARSING_CODE';
+use constant XSLTH_ERR_5 => 'XSLTH_ERR_PARSING_DATA';
+use constant XSLTH_ERR_6 => 'XSLTH_ERR_TRANSFORMING';
+use constant XSLTH_ERR_7 => 'XSLTH_NO_STRING_PASSED';
+
=head2 transform
my $output= $xslt_engine->transform( $xml, $xsltfilename, [$format] );
#check if no string passed
if ( !defined $xml ) {
- $self->_set_error(7);
+ $self->_set_error( XSLTH_ERR_7 );
return; #always undef
}
my $parser = XML::LibXML->new();
my $source = eval { $parser->parse_string($xml) };
if ($@) {
- $self->_set_error( 5, $@ );
+ $self->_set_error( XSLTH_ERR_5, $@ );
return $retval;
}
my $result = eval {
: $stsh->output_as_chars( $transformed ); # default: chars
};
if ($@) {
- $self->_set_error( 6, $@ );
+ $self->_set_error( XSLTH_ERR_6, $@ );
return $retval;
}
$self->{last_xsltfile} = $key;
my $self = shift;
$self->_set_error;
- $self->{xslt_hash} = {};
- $self->{print_warns} = 1 unless exists $self->{print_warns};
+ $self->{xslt_hash} = {};
+ $self->{print_warns} = 1 unless exists $self->{print_warns};
$self->{do_not_return_source} = 0
unless exists $self->{do_not_return_source};
if ( !$filename && !$code ) {
my $last = $self->{last_xsltfile};
if ( !$last || !exists $self->{xslt_hash}->{$last} ) {
- $self->_set_error(1);
+ $self->_set_error( XSLTH_ERR_1 );
return;
}
return $last;
#Check file existence (skipping URLs)
if( $filename && $filename !~ /^https?:\/\// && !-e $filename ) {
- $self->_set_error(2);
+ $self->_set_error( XSLTH_ERR_2 );
return;
}
$parser->load_xml( $self->_load_xml_args($filename, $code) )
};
if ($@) {
- $self->_set_error( 3, $@ );
+ $self->_set_error( XSLTH_ERR_3, $@ );
return;
}
$rv = $code? $digest.$codelen: $filename;
$self->{xslt_hash}->{$rv} = eval { $xslt->parse_stylesheet($style_doc) };
if ($@) {
- $self->_set_error( 4, $@ );
+ $self->_set_error( XSLTH_ERR_4, $@ );
delete $self->{xslt_hash}->{$rv};
return;
}
# Internal routine for handling error information.
sub _set_error {
- my ( $self, $errno, $addmsg ) = @_;
+ my ( $self, $errcode, $warn ) = @_;
- if ( !$errno ) { #clear the error
- $self->{err} = undef;
- $self->{errstr} = undef;
- return;
- }
-
- $self->{err} = $errno;
- if ( $errno == 1 ) {
- $self->{errstr} = "No XSLT file passed.";
- }
- elsif ( $errno == 2 ) {
- $self->{errstr} = "XSLT file not found.";
- }
- elsif ( $errno == 3 ) {
- $self->{errstr} = "Error while loading stylesheet xml:";
- }
- elsif ( $errno == 4 ) {
- $self->{errstr} = "Error while parsing stylesheet:";
- }
- elsif ( $errno == 5 ) {
- $self->{errstr} = "Error while parsing input:";
- }
- elsif ( $errno == 6 ) {
- $self->{errstr} = "Error while transforming input:";
- }
- elsif ( $errno == 7 ) {
- $self->{errstr} = "No string to transform.";
- }
-
- if ($addmsg) {
- $self->{errstr} .= " $addmsg";
- }
-
- warn $self->{errstr} if $self->{print_warns};
- return;
+ $self->{err} = $errcode; #set or clear error
+ warn 'XSLT_Handler: '. $warn if $warn && $self->{print_warns};
}
=head1 AUTHOR
projects / srvgit / blobdiff