API:EPrints/Plugin/Import - Revision history

Tdb01r at 09:56, 22 January 2013

2013-01-22T09:56:39Z

@@ Line 69: / Line 69: @@
 </source>
 Set the handler object.
 <!-- Edit below this comment -->

Tdb01r at 11:31, 2 April 2012

2012-04-02T11:31:19Z

← Older revision		Revision as of 11:31, 2 April 2012
Line 124:		Line 124:

	</source>		</source>
	Generate a warning message using $text.		Generate a warning message using '''$text'''.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->
Line 136:		Line 136:

	</source>		</source>
	Generate an error message using $text.		Generate an error message using '''$text'''.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 11:30, 2 April 2012

2012-04-02T11:30:42Z

← Older revision		Revision as of 11:30, 2 April 2012
Line 108:		Line 108:

	</source>		</source>
	Turn ~~<code>~~$epdata~~</code>~~ into a [[API:EPrints/DataObj\|EPrints::DataObj]] using the [[API:EPrints/DataSet\|dataset]] argument passed in %opts.		Turn '''$epdata''' into a [[API:EPrints/DataObj\|EPrints::DataObj]] using the [[API:EPrints/DataSet\|dataset]] argument passed in %opts.

	Uses the [[API:EPrints/Plugin/Import#handler\|handler]] object to perform the actual object creation.		Uses the [[API:EPrints/Plugin/Import#handler\|handler]] object to perform the actual object creation.

	When sub-classing you '''must''' call ~~<code>~~epdata_to_dataobj~~</code>~~ in order to correctly handle the parse-only and test phases during import.		When sub-classing you '''must''' call [[API:EPrints/Plugin/Import#epdata_to_dataobj\|epdata_to_dataobj]] in order to correctly handle the parse-only and test phases during import.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 11:29, 2 April 2012

2012-04-02T11:29:25Z

@@ Line 45: / Line 45: @@
 * visible
 : "staff" (staff only) or "all" (anyone).
 <!-- Edit below this comment -->
@@ Line 56: / Line 80: @@
 </source>
-Import one or more objects from filehandle FILEHANDLE. FILEHANDLE should be set to binary semantics.
+Import one or more objects from '''FILEHANDLE'''. '''FILEHANDLE''' should be set to binary semantics using {{API:PodLink|file=perlfunc|package_name=perlfunc|section=binmode|text=perlfunc/binmode}}.
 This method should by subclassed.
@@ Line 70: / Line 94: @@
 </source>
-Opens FILENAME for reading, sets binary semantics and calls input_fh to actually read the file.
+Opens '''FILENAME''' for reading, sets binary semantics and calls [[API:EPrints/Plugin/Import#input_fh|input_fh]] to actually read the file.
 This method may be subclassed (e.g. see [[API:EPrints/Plugin/Import/TextFile|EPrints::Plugin::Import::TextFile]]).
@@ Line 89: / Line 113: @@
 When sub-classing you '''must''' call <code>epdata_to_dataobj</code> in order to correctly handle the parse-only and test phases during import.
 <!-- Edit below this comment -->

Tdb01r at 11:23, 2 April 2012

2012-04-02T11:23:11Z

← Older revision		Revision as of 11:23, 2 April 2012
Line 84:		Line 84:

	</source>		</source>
	Turn $epdata into a [[API:EPrints/DataObj\|EPrints::DataObj]] ~~with~~ the dataset passed in %opts.		Turn <code>$epdata</code> into a [[API:EPrints/DataObj\|EPrints::DataObj]] using the [[API:EPrints/DataSet\|dataset]] argument passed in %opts.

	~~Calls~~ handler to perform the actual creation.		Uses the [[API:EPrints/Plugin/Import#handler\|handler]] object to perform the actual object creation.

			When sub-classing you '''must''' call <code>epdata_to_dataobj</code> in order to correctly handle the parse-only and test phases during import.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 11:16, 2 April 2012

2012-04-02T11:16:00Z

← Older revision		Revision as of 11:16, 2 April 2012
Line 17:		Line 17:
	===new===		===new===

	<source lang="perl">$plugin = EPrints::Plugin::Import->new( %~~opts~~ )		<source lang="perl">$plugin = EPrints::Plugin::Import->new( %params )

	</source>		</source>
	~~Create~~ a new Import plugin. ~~Available options~~:		Creates a new Import plugin. In addition to those parameters defined by [[API:EPrints/Plugin\|EPrints::Plugin]]:

	* accept		* accept
	: Array reference of acceptable MIME types.		: Array reference of acceptable MIME types. By default includes '''application/x-eprints-import-XXX''', where <em>XXX</em> is the case-insensitive id of the plugin.

	* actions		* actions
Line 38:		Line 38:

	* produce		* produce
	: Array reference of ~~eprint~~ types this plugin can produce.		: Array reference of object types this plugin can produce.

	* screen		* screen

Tdb01r at 08:58, 2 April 2012

2012-04-02T08:58:26Z

← Older revision		Revision as of 08:58, 2 April 2012
Line 23:		Line 23:

	* accept		* accept
	*: Array reference of acceptable MIME types.		: Array reference of acceptable MIME types.

	* actions		* actions
	*: Array reference of named actions.		: Array reference of named actions.

	* advertise		* advertise
	*: Boolean for whether to advertise this plugin to users.		: Boolean for whether to advertise this plugin to users.

	* arguments		* arguments
	*: Hash reference of supported arguments/default values.		: Hash reference of supported arguments/default values.

	* Handler		* Handler
	*: Reference to a handler class, typically [[API:EPrints/CLIProcessor\|EPrints::CLIProcessor]] or [[API:EPrints/ScreenProcessor\|EPrints::ScreenProcessor]].		: Reference to a handler class, typically [[API:EPrints/CLIProcessor\|EPrints::CLIProcessor]] or [[API:EPrints/ScreenProcessor\|EPrints::ScreenProcessor]].

	* produce		* produce
	*: Array reference of eprint types this plugin can produce.		: Array reference of eprint types this plugin can produce.

	* screen		* screen
	*: The screen id this plugin uses to provide its import UI.		: The screen id this plugin uses to provide its import UI.

	* visible		* visible
	*: "staff" (staff only) or "all" (anyone).		: "staff" (staff only) or "all" (anyone).

	<!-- Edit below this comment -->		<!-- Edit below this comment -->
Line 94:		Line 94:
	<!-- Pod2Wiki=head_copyright -->		<!-- Pod2Wiki=head_copyright -->
	==COPYRIGHT==		==COPYRIGHT==
	Copyright 2000-~~2011~~ University of Southampton.		Copyright 2000-2012 University of Southampton.

	This file is part of EPrints http://www.eprints.org/.		This file is part of EPrints http://www.eprints.org/.

Tdb01r at 08:48, 2 April 2012

2012-04-02T08:48:42Z

← Older revision		Revision as of 08:48, 2 April 2012
Line 94:		Line 94:
	<!-- Pod2Wiki=head_copyright -->		<!-- Pod2Wiki=head_copyright -->
	==COPYRIGHT==		==COPYRIGHT==
	: Copyright 2000-2011 University of Southampton.		Copyright 2000-2011 University of Southampton.

	: This file is part of EPrints http://www.eprints.org/.		This file is part of EPrints http://www.eprints.org/.

	: EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.		EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

	: EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.		EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

	: You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.		You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 08:48, 2 April 2012

2012-04-02T08:48:13Z

← Older revision		Revision as of 08:48, 2 April 2012
Line 12:		Line 12:

	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	$plugin = EPrints::Plugin::Import-~~>~~new( %opts )		<!-- Pod2Wiki=head_methods -->
			==METHODS==
			<!-- Pod2Wiki=head_new -->
			===new===

			<source lang="perl">$plugin = EPrints::Plugin::Import->new( %opts )

			</source>
	Create a new Import plugin. Available options:		Create a new Import plugin. Available options:

Line 39:		Line 46:
	*: "staff" (staff only) or "all" (anyone).		*: "staff" (staff only) or "all" (anyone).

	$plugin-~~>~~input_fh( fh =~~>~~ FILEHANDLE [, %opts] )		<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			<!-- Pod2Wiki=head_input_fh -->
			===input_fh===

			<source lang="perl">$plugin->input_fh( fh => FILEHANDLE [, %opts] )

			</source>
	Import one or more objects from filehandle FILEHANDLE. FILEHANDLE should be set to binary semantics.		Import one or more objects from filehandle FILEHANDLE. FILEHANDLE should be set to binary semantics.

	This method should by subclassed.		This method should by subclassed.

	$plugin-~~>~~input_file( filename =~~>~~ FILENAME [, %opts] )		<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			<!-- Pod2Wiki=head_input_file -->
			===input_file===

			<source lang="perl">$plugin->input_file( filename => FILENAME [, %opts] )

			</source>
	Opens FILENAME for reading, sets binary semantics and calls input_fh to actually read the file.		Opens FILENAME for reading, sets binary semantics and calls input_fh to actually read the file.

	This method may be subclassed (e.g. see [[API:EPrints/Plugin/Import/TextFile\|EPrints::Plugin::Import::TextFile]]).		This method may be subclassed (e.g. see [[API:EPrints/Plugin/Import/TextFile\|EPrints::Plugin::Import::TextFile]]).

	$dataobj = $plugin-~~>~~epdata_to_dataobj( $epdata, %opts )		<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			<!-- Pod2Wiki=head_epdata_to_dataobj -->
			===epdata_to_dataobj===

			<source lang="perl">$dataobj = $plugin->epdata_to_dataobj( $epdata, %opts )

			</source>
	Turn $epdata into a [[API:EPrints/DataObj\|EPrints::DataObj]] with the dataset passed in %opts.		Turn $epdata into a [[API:EPrints/DataObj\|EPrints::DataObj]] with the dataset passed in %opts.

	Calls handler to perform the actual creation.		Calls handler to perform the actual creation.

			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
	<!-- Pod2Wiki=head_copyright -->		<!-- Pod2Wiki=head_copyright -->
	==COPYRIGHT==		==COPYRIGHT==
	Copyright 2000-2011 University of Southampton.		: Copyright 2000-2011 University of Southampton.

	This file is part of EPrints http://www.eprints.org/.		: This file is part of EPrints http://www.eprints.org/.

	EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.		: EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

	EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.		: EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.		: You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r: Created page with '