| Template-XML documentation | Contained in the Template-XML distribution. |
Template::Plugin::XML::XPath - Plugin interface to XML::XPath
# load plugin and specify XML file to parse
[% USE xpath = XML.XPath(xmlfile) %]
[% USE xpath = XML.XPath(file => xmlfile) %]
[% USE xpath = XML.XPath(filename => xmlfile) %]
# load plugin and specify XML text to parse
[% USE xpath = XML.XPath(xmltext) %]
[% USE xpath = XML.XPath(xml => xmltext) %]
[% USE xpath = XML.XPath(text => xmltext) %]
# then call any XPath methods (see XML::XPath docs)
[% FOREACH page = xpath.findnodes('/html/body/page') %]
[% page.getAttribute('title') %]
[% END %]
# define VIEW to present node(s)
[% VIEW repview notfound='xmlstring' %]
# handler block for a <report>...</report> element
[% BLOCK report %]
[% item.content(view) %]
[% END %]
# handler block for a <section title="...">...</section> element
[% BLOCK section %]
<h1>[% item.getAttribute('title') | html %]</h1>
[% item.content(view) %]
[% END %]
# default template block passes tags through and renders
# out the children recursivly
[% BLOCK xmlstring;
item.starttag; item.content(view); item.endtag;
END %]
# block to generate simple text
[% BLOCK text; item | html; END %]
[% END %]
# now present node (and children) via view
[% repview.print(page) %]
# or print node content via view
[% page.content(repview) %]
This is a Template Toolkit plugin interfacing to the XML::XPath module.
All methods implemented by the XML::XPath modules are available. In addition, the XML::XPath::Node::Element module implements present($view) and content($view) methods method for seamless integration with Template Toolkit VIEWs. The XML::XPath::Node::Text module is also adorned with a present($view) method which presents itself via the view using the 'text' template.
To aid the reconstruction of XML, methods starttag and endtag are added to XML::XPath::Node::Element which return the start and end tag for that element. This means that you can easily do:
[% item.starttag %][% item.content(view) %][% item.endtag %]
To render out the start tag, followed by the content rendered in the view "view", followed by the end tag.
This plugin module was written by Andy Wardley.
The XML::XPath module is by Matt Sergeant.
Copyright (C) 1996-2006 Andy Wardley. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| Template-XML documentation | Contained in the Template-XML distribution. |
#============================================================= -*-Perl-*- # # Template::Plugin::XML::XPath # # DESCRIPTION # Template Toolkit plugin interfacing to the XML::XPath.pm module. # # AUTHOR # Andy Wardley <abw@cpan.org> # # COPYRIGHT # Copyright (C) 2000-2006 Andy Wardley. All Rights Reserved. # # This module is free software; you can redistribute it and/or # modify it under the same terms as Perl itself. # #============================================================================ package Template::Plugin::XML::XPath; use strict; use warnings; use Template::Exception; use base 'Template::Plugin'; use XML::XPath; our $VERSION = 2.71; #------------------------------------------------------------------------ # new($context, \%config) # # Constructor method for XML::XPath plugin. Creates an XML::XPath # object and initialises plugin configuration. #------------------------------------------------------------------------ sub new { my $class = shift; my $context = shift; my $args = ref $_[-1] eq 'HASH' ? pop(@_) : { }; my ($content, $about); # determine the input source from a positional parameter (may be a # filename or XML text if it contains a '<' character) or by using # named parameters which may specify one of 'file', 'filename', 'text' # or 'xml' if ($content = shift) { if ($content =~ /\</) { $about = 'xml text'; $args->{ xml } = $content; } else { $about = "xml file $content"; $args->{ filename } = $content; } } elsif ($content = $args->{ text } || $args->{ xml }) { $about = 'xml text'; $args->{ xml } = $content; } elsif ($content = $args->{ file } || $args->{ filename }) { $about = "xml file $content"; $args->{ filename } = $content; } else { return $class->_throw('no filename or xml text specified'); } return XML::XPath->new(%$args) or $class->_throw("failed to create XML::XPath::Parser\n"); } #------------------------------------------------------------------------ # _throw($errmsg) # # Raise a Template::Exception of type XML.XPath via die(). #------------------------------------------------------------------------ sub _throw { my ($self, $error) = @_; die (Template::Exception->new('XML.XPath', $error)); } #======================================================================== package XML::XPath::Node::Element; #======================================================================== #------------------------------------------------------------------------ # present($view) # # Method to present an element node via a view. #------------------------------------------------------------------------ sub present { my ($self, $view) = @_; $view->view($self->getName(), $self); } sub content { my ($self, $view) = @_; my $output = ''; foreach my $node (@{ $self->getChildNodes }) { $output .= $node->present($view); } return $output; } #---------------------------------------------------------------------- # starttag(), endtag() # # Methods to output the start & end tag, e.g. <foo bar="baz"> & </foo> #---------------------------------------------------------------------- sub starttag { my ($self) = @_; my $output = "<". $self->getName(); foreach my $attr ($self->getAttributes()) { $output .= $attr->toString(); } $output .= ">"; return $output; } sub endtag { my ($self) = @_; return "</". $self->getName() . ">"; } #======================================================================== package XML::XPath::Node::Text; #======================================================================== #------------------------------------------------------------------------ # present($view) # # Method to present a text node via a view. #------------------------------------------------------------------------ sub present { my ($self, $view) = @_; $view->view('text', $self->string_value); } #======================================================================== package XML::XPath::Node::Comment; #======================================================================== sub present { return ''; } sub starttag { return ''; } sub endtag { return ''; } 1; __END__