Contribute: Plugins/ExportPluginsExcel - Revision history

Pm705 at 13:33, 8 February 2010

2010-02-08T13:33:11Z

← Older revision		Revision as of 13:33, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Plugins]]
	= Export Plugin Tutorial 4: Excel =		= Export Plugin Tutorial 4: Excel =

Tom: /* Constructor */

2007-09-28T19:00:02Z

Constructor

← Older revision		Revision as of 19:00, 28 September 2007
Line 130:		Line 130:
	</pre>		</pre>

	The file extension and MIME type are set to values appropriate for Excel files.		The file extension and [http://en.wikipedia.org/wiki/MIME MIME] type are set to values appropriate for Excel files.
	<pre>		<pre>
	$self->{suffix} = '.xls';		$self->{suffix} = '.xls';
Line 145:		Line 145:
	}		}
	</pre>		</pre>

	== List Handling ==		== List Handling ==
	=== Setting Up a Workbook ===		=== Setting Up a Workbook ===

Tom: /* Excel.pm */

2007-09-28T13:48:12Z

Excel.pm

← Older revision		Revision as of 13:48, 28 September 2007
Line 10:		Line 10:

	= Excel.pm =		= Excel.pm =
			The code in the section below should be placed in a file called Excel.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.

	<pre>		<pre>

Tom: /* Testing Your Plugin */

2007-09-28T10:25:51Z

Testing Your Plugin

← Older revision		Revision as of 10:25, 28 September 2007
Line 248:		Line 248:

	= Testing Your Plugin =		= Testing Your Plugin =
	Restart your webserver and test the plugin as in [[~~User~~:~~Tom~~/~~Export_Plugins/HTML~~ \| ~~the previous tutorial~~]].		Restart your webserver and test the plugin as [[Contribute:_Plugins/ExportPluginsHello\| before]].

	== Sample Output ==		== Sample Output ==
	[[Image:Expexcel.png]]		[[Image:Expexcel.png]]

Tom: User:Tom/Export Plugins/Excel moved to Contribute: Plugins/ExportPluginsExcel

2007-09-27T20:56:05Z

User:Tom/Export Plugins/Excel moved to Contribute: Plugins/ExportPluginsExcel

← Older revision	Revision as of 20:56, 27 September 2007
(No difference)

Tom: /* In More Detail */

2007-09-27T12:13:52Z

In More Detail

← Older revision		Revision as of 12:13, 27 September 2007
Line 123:		Line 123:

	= In More Detail =		= In More Detail =
	~~== Modules ==~~
	~~We need to import a module for creating Excel files.~~
	~~<pre>~~
	~~use Spreadsheet::WriteExcel;~~
	~~</pre>~~

	== Constructor ==		== Constructor ==
	For the sake of simplicity this plugin will only deal with lists of eprints. This avoids some code duplication, and it would be fairly easy to modify the plugin to deal with both individual eprints and lists of eprints sensibly.		For the sake of simplicity this plugin will only deal with lists of eprints. This avoids some code duplication, and it would be fairly easy to modify the plugin to deal with both individual eprints and lists of eprints sensibly.
Line 137:		Line 131:
	The file extension and MIME type are set to values appropriate for Excel files.		The file extension and MIME type are set to values appropriate for Excel files.
	<pre>		<pre>
	$self->{suffix} = ".xls";		$self->{suffix} = '.xls';
	$self->{mimetype} = "application/vnd.ms-excel";		$self->{mimetype} = 'application/vnd.ms-excel';
	</pre>		</pre>

			We need to import a module that is not included with EPrints for creating zip files. We use the EPrints::Utils::require_if_exists function to check if the module exists, and load it if it does. We then check the value returned from that function, and make the plugin invisible if it failed.
			<pre>
			my $rc = EPrints::Utils::require_if_exists('Spreadsheet::WriteExcel');
			unless ($rc)
			{
			$self->{visible} = '';
			$self->{error} = 'Unable to load required module Spreadsheet::WriteExcel';
			}
			</pre>
	== List Handling ==		== List Handling ==
	=== Setting Up a Workbook ===		=== Setting Up a Workbook ===
Line 151:		Line 154:
	open(my $FH,'>',\$output);		open(my $FH,'>',\$output);

	if (defined $opts{"fh"})		if (defined $opts{fh})
	{		{
	$workbook = Spreadsheet::WriteExcel->new(\*{$opts{"fh"}});		$workbook = Spreadsheet::WriteExcel->new(\*{$opts{fh}});
	die("Unable to create spreadsheet: $!")unless defined $workbook;		die("Unable to create spreadsheet: $!")unless defined $workbook;
	}		}
Line 172:		Line 175:
	<pre>		<pre>
	my @fields =		my @fields =
	$plugin->{session}->get_repository->get_dataset("archive")->get_fields;		$plugin->{session}->get_repository->get_dataset('archive')->get_fields;
	</pre>		</pre>

Line 200:		Line 203:
	The plugin handles fields which can take multiple values in a number of ways.		The plugin handles fields which can take multiple values in a number of ways.
	<pre>		<pre>
	if ($field->get_property("multiple"))		if ($field->get_property('multiple'))
	</pre>		</pre>
	Names are handled specially and are formatted with the family name followed by a comma, the given name or initial and then a semi-colon.		Names are handled specially and are formatted with the family name followed by a comma, the given name or initial and then a semi-colon.
	<pre>		<pre>
	if ($field->{type} eq "name")		if ($field->{type} eq 'name')
	{		{
	my $namelist = '';		my $namelist = '';
	foreach my $name (@{$dataobj->get_value_raw($field->get_name)})		foreach my $name (@{$dataobj->get_value_raw($field->get_name)})
	{		{
	$namelist .= $name->{family} . "," . $name->{given} . ";";		$namelist .= $name->{family} . ',' . $name->{given} . ';';
	}		}
	$worksheet->write($i, $j, $namelist);		$worksheet->write($i, $j, $namelist);
	}		}
	</pre>		</pre>
	Fields which have a compound type are not handled, and "COMPOUND" is written to the worksheet.		Fields which have a compound type are not handled, and 'COMPOUND' is written to the worksheet.
	<pre>		<pre>
	elsif ($field->{type} eq "compound")		elsif ($field->{type} eq 'compound')
	{		{
	$worksheet->write($i, $j, "COMPOUND");		$worksheet->write($i, $j, 'COMPOUND');
	}		}
	</pre>		</pre>
Line 231:		Line 234:

	=== Finishing Up ===		=== Finishing Up ===

	We first need to close the workbook to ensure that the data is written to the file handles, and then we can return in the usual fashion.		We first need to close the workbook to ensure that the data is written to the file handles, and then we can return in the usual fashion.
	<pre>		<pre>
	$workbook->close;		$workbook->close;

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

Tom: /* Excel.pm */

2007-09-27T11:44:58Z

Excel.pm

← Older revision		Revision as of 11:44, 27 September 2007
Line 14:		Line 14:
	package EPrints::Plugin::Export::MyPlugins::Excel;		package EPrints::Plugin::Export::MyPlugins::Excel;

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

	use strict;		use strict;
	~~use Spreadsheet::WriteExcel;~~

	sub new		sub new
Line 24:		Line 23:
	my $self = $class->SUPER::new(%opts);		my $self = $class->SUPER::new(%opts);

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

			my $rc = EPrints::Utils::require_if_exists('Spreadsheet::WriteExcel');
			unless ($rc)
			{
			$self->{visible} = '';
			$self->{error} = 'Unable to load required module Spreadsheet::WriteExcel';
			}

	return $self;		return $self;
Line 41:		Line 47:
	open(my $FH,'>',\$output);		open(my $FH,'>',\$output);

	if (defined $opts{"fh"})		if (defined $opts{fh})
	{		{
	$workbook = Spreadsheet::WriteExcel->new(\*{$opts{"fh"}});		$workbook = Spreadsheet::WriteExcel->new(\*{$opts{fh}});
	die("Unable to create spreadsheet: $!")unless defined $workbook;		die("Unable to create spreadsheet: $!")unless defined $workbook;
	}		}
Line 56:		Line 62:
	my $i = 0;		my $i = 0;
	my @fields =		my @fields =
	$plugin->{session}->get_repository->get_dataset("archive")->get_fields;		$plugin->{session}->get_repository->get_dataset('archive')->get_fields;

	foreach my $field (@fields)		foreach my $field (@fields)
Line 72:		Line 78:
	if ($dataobj->exists_and_set($field->get_name))		if ($dataobj->exists_and_set($field->get_name))
	{		{
	if ($field->get_property("multiple"))		if ($field->get_property('multiple'))
	{		{
	if ($field->{type} eq "name")		if ($field->{type} eq 'name')
	{		{
	my $namelist = '';		my $namelist = '';
	foreach my $name (@{$dataobj->get_value_raw($field->get_name)})		foreach my $name (@{$dataobj->get_value_raw($field->get_name)})
	{		{
	$namelist .= $name->{family} . "," . $name->{given} . ";";		$namelist .= $name->{family} . ',' . $name->{given} . ';';
	}		}
	$worksheet->write($i, $j, $namelist);		$worksheet->write($i, $j, $namelist);
	}		}
	elsif ($field->{type} eq "compound")		elsif ($field->{type} eq 'compound')
	{		{
	$worksheet->write($i, $j, "COMPOUND");		$worksheet->write($i, $j, 'COMPOUND');
	}		}
	else		else
Line 104:		Line 110:
	$workbook->close;		$workbook->close;

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

Tom: /* Testing Your Plugin */

2007-09-03T13:41:28Z

Testing Your Plugin

← Older revision		Revision as of 13:41, 3 September 2007
Line 239:		Line 239:
	= Testing Your Plugin =		= Testing Your Plugin =
	Restart your webserver and test the plugin as in [[User:Tom/Export_Plugins/HTML \| the previous tutorial]].		Restart your webserver and test the plugin as in [[User:Tom/Export_Plugins/HTML \| the previous tutorial]].

			== Sample Output ==
			[[Image:Expexcel.png]]

Tom: /* Finishing Up */

2007-09-03T11:46:01Z

Finishing Up

← Older revision		Revision as of 11:46, 3 September 2007
Line 225:		Line 225:

	=== Finishing Up ===		=== Finishing Up ===
			We first need to close the workbook to ensure that the data is written to the file handles, and then we can return in the usual fashion.
	<pre>		<pre>
	$workbook->close;		$workbook->close;

Tom: /* Handling DataObjs */

2007-09-03T11:44:55Z

Handling DataObjs

← Older revision		Revision as of 11:44, 3 September 2007
Line 158:		Line 158:

	=== Handling DataObjs ===		=== Handling DataObjs ===
			To start adding data to the Excel file we have to create a worksheet.
	<pre>		<pre>
	my $worksheet = $workbook->add_worksheet();		my $worksheet = $workbook->add_worksheet();
			</pre>

	~~my $i = 0;~~		To the first row of our worksheet we add the names of all the metadata fields that can be associated with eprints. We get the session associated with the plugin, and then the repository associated with that session. We then get the DataSet "archive" from that repository and call the get_fields method. That method returns an array of MetaField objects.
			<pre>
	my @fields =		my @fields =
	$plugin->{session}->get_repository->get_dataset("archive")->get_fields;		$plugin->{session}->get_repository->get_dataset("archive")->get_fields;
			</pre>

			Here we loop over each field and write it's name to our worksheet.
			<pre>
	foreach my $field (@fields)		foreach my $field (@fields)
	{		{
Line 170:		Line 176:
	$i++;		$i++;
	}		}
			</pre>

	~~$i = 1;~~		We now loop over each DataObj in our list, and over each MetaField we found earlier.
			<pre>
	foreach my $dataobj ($opts{list}->get_records)		foreach my $dataobj ($opts{list}->get_records)
	{		{
Line 177:		Line 185:
	foreach my $field (@fields)		foreach my $field (@fields)
	{		{
			</pre>

			We only write something to the worksheet if the field can apply to the DataObj and is set. Scalar values are simply written to the worksheet.
			<pre>
	if ($dataobj->exists_and_set($field->get_name))		if ($dataobj->exists_and_set($field->get_name))
	{		</pre>

			The plugin handles fields which can take multiple values in a number of ways.
			<pre>
	if ($field->get_property("multiple"))		if ($field->get_property("multiple"))
	{		</pre>
			Names are handled specially and are formatted with the family name followed by a comma, the given name or initial and then a semi-colon.
			<pre>
	if ($field->{type} eq "name")		if ($field->{type} eq "name")
	{		{
Line 190:		Line 207:
	$worksheet->write($i, $j, $namelist);		$worksheet->write($i, $j, $namelist);
	}		}
			</pre>
			Fields which have a compound type are not handled, and "COMPOUND" is written to the worksheet.
			<pre>
	elsif ($field->{type} eq "compound")		elsif ($field->{type} eq "compound")
	{		{
	$worksheet->write($i, $j, "COMPOUND");		$worksheet->write($i, $j, "COMPOUND");
	}		}
			</pre>
			For most multiple fields each value is taken and concatenated, separated by semi-colons.
			<pre>
	else		else
	{		{
Line 199:		Line 222:
	join(';',@{$dataobj->get_value($field->get_name)}));		join(';',@{$dataobj->get_value($field->get_name)}));
	}		}
	}
	~~else {~~
	~~$worksheet->write($i, $j, $dataobj->get_value($field->get_name));~~
	}
	}
	~~$j++;~~
	}
	~~$i++;~~
	}
	</pre>		</pre>