Difference between revisions of "Contribute: Plugins/ExportPluginsExcel"

From EPrints Documentation
Jump to: navigation, search
m (Skeleton)
 
(Excel.pm: Code)
Line 4: Line 4:
  
 
<pre>
 
<pre>
 +
package EPrints::Plugin::Export::MyPlugins::Excel;
 +
 +
@ISA = ("EPrints::Plugin::Export");
 +
 +
use strict;
 +
use Spreadsheet::WriteExcel;
 +
use IO::File;
 +
use IO::String;
 +
 +
sub new
 +
{
 +
my ($class, %opts) = @_;
 +
my $self = $class->SUPER::new(%opts);
 +
 +
$self->{name} = "Excel";
 +
$self->{accept} = ['list/eprint'];
 +
$self->{visible} = "all";
 +
$self->{suffix} = ".xls";
 +
$self->{mimetype} = "application/vnd.ms-excel";
 +
 +
return $self;
 +
}
 +
 +
sub output_list
 +
{
 +
my ($plugin, %opts) = @_;
 +
my $workbook;
 +
 +
my $output;
 +
my $FH = IO::String->new(\$output);
 +
 +
if (defined $opts{"fh"})
 +
{
 +
$workbook = Spreadsheet::WriteExcel->new(\*{$opts{"fh"}});
 +
die("Unable to create spreadsheet: $!")unless defined $workbook;
 +
}
 +
else
 +
{
 +
$workbook = Spreadsheet::WriteExcel->new($FH);
 +
die("Unable to create spreadsheet: $!")unless defined $workbook;
 +
}
 +
 +
foreach my $dataobj ($opts{"list"}->get_records)
 +
{
 +
my $worksheet = $workbook->add_worksheet();
 +
my $i = 0;
 +
foreach my $field ($dataobj->get_dataset->get_fields)
 +
{
 +
next unless $dataobj->exists_and_set($field->get_name);
 +
$worksheet->write($i, 0, $field->get_name);
 +
$worksheet->write_string($i, 1, $dataobj->get_value($field->get_name));
 +
$i++;
 +
}
 +
}
 +
 +
$workbook->close;
 +
 +
if (defined $opts{"fh"})
 +
{
 +
return undef;
 +
}
 +
 +
return $output;
 +
}
 +
 +
1;
 +
 
</pre>
 
</pre>
  

Revision as of 10:26, 30 August 2007

Export Plugin Tutorial 4: Excel

Excel.pm

package EPrints::Plugin::Export::MyPlugins::Excel;

@ISA = ("EPrints::Plugin::Export");

use strict;
use Spreadsheet::WriteExcel;
use IO::File;
use IO::String;

sub new
{
	my ($class, %opts) = @_;
	my $self = $class->SUPER::new(%opts);

	$self->{name} = "Excel";
	$self->{accept} = ['list/eprint'];
	$self->{visible} = "all";
	$self->{suffix} = ".xls";
	$self->{mimetype} = "application/vnd.ms-excel";

	return $self;
}

sub output_list
{
	my ($plugin, %opts) = @_;
	my $workbook;

	my $output;
	my $FH = IO::String->new(\$output);

	if (defined $opts{"fh"})
	{
		$workbook = Spreadsheet::WriteExcel->new(\*{$opts{"fh"}});
		die("Unable to create spreadsheet: $!")unless defined $workbook;
	}
	else 
	{
		$workbook = Spreadsheet::WriteExcel->new($FH);
		die("Unable to create spreadsheet: $!")unless defined $workbook;
	}

	foreach my $dataobj ($opts{"list"}->get_records)
	{
		my $worksheet = $workbook->add_worksheet();
		my $i = 0;
		foreach my $field ($dataobj->get_dataset->get_fields)
		{
			next unless $dataobj->exists_and_set($field->get_name);
			$worksheet->write($i, 0, $field->get_name);	
			$worksheet->write_string($i, 1, $dataobj->get_value($field->get_name));	
			$i++;
		}
	}

	$workbook->close;

	if (defined $opts{"fh"})
	{
		return undef;
	}

	return $output;
}

1;

In More Detail

Testing Your Plugin

Restart your webserver and test the plugin as in the previous tutorial.