File Coverage

blib/lib/DBI/ResultPager.pm

Criterion	Covered	Total	%
statement	18	148	12.1
branch	0	38	0.0
condition			n/a
subroutine	6	18	33.3
pod	2	12	16.6
total	26	216	12.0

#!/usr/bin/perl

package DBI::ResultPager;

use strict;
use warnings;
use CGI qw/:standard/;
use DBI;

BEGIN {
	use Exporter ();
	our ($VERSION, @ISA);
	$VERSION = '0.9.2';
	@ISA = qw(Exporter);
}


sub new {
	my $self = {};
	$self->{DBH} = '';
	$self->{QUERY} = '';
	$self->{PERPAGE} = 30;
	$self->{DEFAULTORDER} = '';
	$self->{ALIGN} = '';

	my %fmt = ();
	my %hidden = ();
	my @cc;

	$self->{FORMATTERS} = \%fmt;
	$self->{CUSTOMCOLUMNS} = \@cc;
	$self->{HIDDENCOLUMNS} = \%hidden;

	bless($self);
	return $self;
}

sub display {
	my ($self, @params) = (@_);
	my $rv = getOutput($self, @params);
	print $rv;
}

sub getOutput {
	my ($self, @params) = (@_);

	my $output = '';

	my @columns;
	my $page = 1;

	if(defined(url_param('page'))) {
		$page = url_param('page');
	}

	my $hidden = $self->{HIDDENCOLUMNS};
	my $query = $self->{QUERY};
	my $perPage = $self->{PERPAGE};
	my $offset = (($page - 1) * $perPage);
	my $dbh = $self->{DBH};
	my $order = $self->{DEFAULTORDER};

	my $ccref = $self->{CUSTOMCOLUMNS};
	my @customColumns = @$ccref;

	if($order ne '') {
		$query = $query . ' order by ' . $order;
	}

	$query = $query . ' limit ' . ($perPage + 1);

	if($page ne 1) {
		$query = $query . " offset $offset";
	}

	my $sth = $dbh->prepare($query);
	$sth->execute(@params) or die "Error in $query: $!\n";

	$output .= ''; '; '; '; \n"; '; '; \n"; 




80




 





 





 





 





 





 



 	 




81




0





 





 





 





 





 



 	my $nref = $sth->{NAME}; 




82




0





 





 





 





 





 



 	my @names = @$nref; 




83




 





 





 





 





 





 



   




84




 





 





 





 





 





 



 	# Print the header. 




85




0





 





 





 





 





 



 	$output .= '




86




0





 





 





 





 





 



 	foreach(@names) { 




87




0




  
  0
  




 





 





 





 



 		if(!defined($hidden->{$_})) { 




88




0





 





 





 





 





 



 			$output .= '' . $_ . '




89




 





 





 





 





 





 



 		} 




90




 





 





 





 





 





 



 		 




91




0





 





 





 





 





 



 		push(@columns, $_);		 




92




 





 





 





 





 





 



 	} 




93




 





 





 





 





 





 



   




94




0





 





 





 





 





 



 	foreach(@customColumns) { 




95




0





 





 





 





 





 



 		$output .= '' . $_->{'columnName'} . '




96




 





 





 





 





 





 



 	} 




97




 





 





 





 





 





 



   




98




 





 





 





 





 





 



 	# Add headers for any custom columns 




99




 





 





 





 





 





 



 	 




100




0





 





 





 





 





 



 	$output .= "




101




 





 





 





 





 





 



 	 




102




0





 





 





 





 





 



 	my $formatters = $self->{FORMATTERS}; 




103




0





 





 





 





 





 



 	my $count = 0; 




104




0





 





 





 





 





 



 	while(my @row = $sth->fetchrow_array()) { 




105




0





 





 





 





 





 



 		$count++; 




106




 





 





 





 





 





 



 		 




107




0




  
  0
  




 





 





 





 



 		if($count > $perPage) { next; } 




 




0





 





 





 





 





 



   




108




 





 





 





 





 





 



   




109




0





 





 





 





 





 



 		my $color = ""; 




110




0




  
  0
  




 





 





 





 



 		if( ($count %2) eq 1) { 




111




0





 





 





 





 





 



 			$color = ' bgcolor="#EEEEEE"'; 




112




 





 





 





 





 





 



 		} 




113




 





 





 





 





 





 



   




114




0





 





 





 





 





 



 		$output .= ""; 




115




0





 





 





 





 





 



 		my $colcount = 0; 




116




0





 





 





 





 





 



 		my $al = ''; 




117




0





 





 





 





 





 



 		my $align = $self->{ALIGN}; 




118




0




  
  0
  




 





 





 





 



 		if($align ne '') { 




119




0





 





 





 





 





 



 			$al = ' valign="' . $align . '"'; 




120




 





 





 





 





 





 



 		} 




121




 





 





 





 





 





 



   




122




0





 





 





 





 





 



 		foreach(@row) { 




123




0





 





 





 





 





 



 			$colcount++; 




124




0





 





 





 





 





 



 			my $colname = $columns[$colcount - 1]; 




125




 





 





 





 





 





 



 			 




126




0




  
  0
  




 





 





 





 



 			if(defined($hidden->{$colname})) { next; } 




 




0





 





 





 





 





 



   




127




 





 





 





 





 





 



 			 




128




0





 





 





 





 





 



 			$output .= ''; 




129




 





 





 





 





 





 



   




130




 





 





 





 





 





 



 			# Check if this column has a custom formatter 




131




0




  
  0
  




 





 





 





 



 			if(defined($formatters->{$colname})) { 




132




0





 





 





 





 





 



 				my $subref = $formatters->{$colname}; 




133




0





 





 





 





 





 



 				$output .= &$subref($_, \@row); 




134




 





 





 





 





 





 



 			} else {	 




135




0





 





 





 





 





 



 				$output .= $_; 




136




 





 





 





 





 





 



 			} 




137




 





 





 





 





 





 



   




138




0





 





 





 





 





 



 			$output .= '




139




 





 





 





 





 





 



 		} 




140




 





 





 





 





 





 



 	 




141




0





 





 





 





 





 



 		foreach(@customColumns) { 




142




0





 





 





 





 





 



 			$output .= ''; 




143




0





 





 





 





 





 



 			my $cref = $_->{'codeRef'}; 




144




0





 





 





 





 





 



 			$output .= &$cref(@row) .  '




145




 





 





 





 





 





 



 		} 




146




 





 





 





 





 





 



   




147




0





 





 





 





 





 



 		$output .= "




148




 





 





 





 





 





 



 	} 




149




 





 





 





 





 





 



   




150




0





 





 





 





 





 



 	$output .= '';

	my $nref = $sth->{NAME};
	my @names = @$nref;

	# Print the header.
	$output .= '
	foreach(@names) {
		if(!defined($hidden->{$_})) {
			$output .= '
		}

		push(@columns, $_);
	}

	foreach(@customColumns) {
		$output .= '
	}

	# Add headers for any custom columns

	$output .= "

	my $formatters = $self->{FORMATTERS};
	my $count = 0;
	while(my @row = $sth->fetchrow_array()) {
		$count++;

		if($count > $perPage) { next; }

		my $color = "";
		if( ($count %2) eq 1) {
			$color = ' bgcolor="#EEEEEE"';
		}

		$output .= "";
		my $colcount = 0;
		my $al = '';
		my $align = $self->{ALIGN};
		if($align ne '') {
			$al = ' valign="' . $align . '"';
		}

		foreach(@row) {
			$colcount++;
			my $colname = $columns[$colcount - 1];

			if(defined($hidden->{$colname})) { next; }

			$output .= '';

			# Check if this column has a custom formatter
			if(defined($formatters->{$colname})) {
				my $subref = $formatters->{$colname};
				$output .= &$subref($_, \@row);
			} else {
				$output .= $_;
			}

			$output .= '
		}

		foreach(@customColumns) {
			$output .= '';
			my $cref = $_->{'codeRef'};
			$output .= &$cref(@row) .  '
		}

		$output .= "
	}

	$output .= '

	my $prev = 0;
	if($offset ne 0) {
		my $u = manglePage($page - 1);
		$output .= 'Previous Page';
		$prev = 1;
	}

	if($count > $perPage) {

		if($prev ne 0) {
			$output .= ' | ';
		}

		my $u = manglePage($page + 1);
		$output .= 'Next Page';
	}

	$output .= '';
}

sub alignRows {
	my ($self, $align) = (@_);
	$self->{ALIGN} = $align;
}

# Returns the current URL with the given page number.
# FIXME: URL params only
sub manglePage {
	my ($page) = (@_);

	my $u = url(-relative=>1, -query=>1);
	if($u =~ /[\?&;]page=/) {
		$u =~ s/[\?&;]page=[0-9]*//;
	}

	if($u =~ /\?/) {
		$u = $u . '&page=' . $page;
	} else {
		$u = $u . '?page=' . $page;
	}

	return $u;
}

sub hideColumn {
	my ($self, $columnName) = (@_);
	my $ar = $self->{HIDDENCOLUMNS};
	$ar->{$columnName} = 1;
}

sub addCustomColumn {
	my ($self, $columnName, $codeRef, $identityColumn) = (@_);

	my %cc = ();

	$cc{'columnName'} = $columnName;
	$cc{'codeRef'} = $codeRef;

	my $ar = $self->{CUSTOMCOLUMNS};
	push(@$ar, \%cc); # Push the hashref onto the arrayref.
}

sub addColumnFormatter {
	my ($self, $column, $formatref) = (@_);

	my $formatters = $self->{FORMATTERS};
	$formatters->{$column} = $formatref;
}

sub defaultOrder {
	my $self = shift;
	if(@_) { $self->{DEFAULTORDER} = shift; }
	return $self->{DEFAULTORDER};
}

sub dbh {
	my $self = shift;
	if(@_) { $self->{DBH} = shift; }
	return $self->{DBH};
}

sub perPage {
	my $self = shift;
	if(@_) { $self->{PERPAGE} = shift; }
	return $self->{PERPAGE};
}

sub query {
	my $self = shift;
	if(@_) { $self->{QUERY} = shift; }
	return $self->{QUERY};
}

1;
__END__