File Coverage

blib/lib/CGI/Application/Plugin/PageBuilder.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch	2	4	50.0
condition			n/a
subroutine	6	6	100.0
pod	3	3	100.0
total	38	40	95.0

=head1 NAME

CGI::Application::Plugin::PageBuilder - Simplifies building pages with multiple templates.

=head1 SYNOPSIS

This module simplifies building complex web pages with many small piecemeal templates.

Instead of

 sub run_mode {
     my $self = shift;
     my $header = $self->load_tmpl( 'header.tmpl' )->output();
     my $html;

     my $start = $self->load_tmpl( 'view_start.tmpl' );
     $start->param( view_name => 'This View' );
     $html .= $start->output();

     my $db = MyApp::DB::Views->retrieve_all(); # Class::DBI
     while ( my $line = $db->next() ) {
         my $template = $self->load_tmpl( 'view_element.tmpl' );
         $template->param( name => $line->name() );
         $template->param( info => $line->info() );
         $html .= $template->output();
     }
     $html .= $self->load_tmpl( 'view_end.tmpl' )->output();
     $html .= $self->load_tmpl( 'footer.tmpl' )->output();
     return $html;
 }

You can do this:

 CGI:App subclass:

 sub run_mode {
     my $self = shift;

     $self->pb_template( 'header.tmpl' );
     $self->pb_template( 'view_start.tmpl' );

     my $db = MyApp::DB::Views->retrieve_all();
     while( my $line = $db->next() ) {
         $self->pb_template( 'view_row.tmpl' );
         $self->pb_param( name, $line->name() );
         $self->pb_param( info, $line->info() );
     }
     $self->pb_template( 'view_end.tmpl' );
     $self->pb_template( 'footer.tmpl' );
     return $self->pb_build();
 }

=head1 METHODS

=head2 pb_template

$self->pb_template( 'the_template_to_use.tmpl', ... );

Adds the template to the page.  Any arguments past the template name are passed on to HTML::Template.

=head2 pb_param

$self->pb_param( name, value );

Sets the value for the param in the template.  This applies to the last template loaded by B.

=head2 pb_build

$self->pb_build();

Returns the combined page.

=head1 AUTHOR

Clint Moore [e-mail]

=head1 LICENSE AND COPYRIGHT

Copyright (c) 2005, Clint Moore C<<  >>.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

=cut

package CGI::Application::Plugin::PageBuilder;
use strict;

use base 'Exporter';
use vars qw/ @EXPORT $VERSION /;
$VERSION='1.00';

@EXPORT = qw( pb_template pb_param pb_build );

sub pb_template {
	my( $self, $template, %options ) = @_;

	my $t_template = $self->load_tmpl( $template, %options );
	return unless $t_template;

	push( @{ $self->{__PB_TEMPLATE_LIST} }, $t_template );
	$self->{__PB__TEMPLATE_COUNT}++;
	return $self->pb_build();
}

sub pb_build {
	my $self = shift;

	$self->{__PB_BUFFER} = '';
	foreach my $template ( @{ $self->{__PB_TEMPLATE_LIST} } ) {
		$self->{__PB_BUFFER} .= $template->output();
	}
	return $self->{__PB_BUFFER};
}

sub pb_param {
	my( $self, $param, $value ) = @_;

	return unless $value;
	${$self->{__PB_TEMPLATE_LIST}}[-1]->param( $param, $value );
	return $self->pb_build();
}

1;