Difference between revisions of "API:EPrints/Plugin"

From EPrints Documentation
Jump to: navigation, search
Line 37: Line 37:
 
</source>
 
</source>
 
Create a new instance of a plugin. Defines the following parameters:
 
Create a new instance of a plugin. Defines the following parameters:
 +
 +
* repository
 +
: Required handle to the current repository object.
 +
 +
* name
 +
: Human-readable name of the plugin.
 +
 +
* alias
 +
: Array reference of plugin id's that this plugin is aliasing (replacing).
  
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
Line 42: Line 51:
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_repository -->
+
<!-- Pod2Wiki=head_mime_type -->
===repository===
+
===mime_type===
  
<source lang="perl">repository
+
<source lang="perl">$mime_type = EPrints::Plugin->mime_type()
  
 
</source>
 
</source>
Required handle to the current repository object.
+
Returns the MIME type for this plugin.
 +
 
 +
Returns undef if there is no relevant MIME type for this plugin type.
  
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
Line 54: Line 65:
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_name -->
+
<!-- Pod2Wiki=head_local_uri -->
===name===
+
===local_uri===
  
<source lang="perl">name
+
<source lang="perl">$value = EPrints::Plugin->local_uri
  
 
</source>
 
</source>
Human-readable name of the plugin.
+
Return a unique ID for this plugin as it relates to the current  repository. This can be used to distinguish that XML import for  different repositories may have minor differences.
 +
 
 +
This URL will not resolve to anything useful.
  
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
Line 66: Line 79:
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_alias -->
+
<!-- Pod2Wiki=head_global_uri -->
===alias===
+
===global_uri===
  
<source lang="perl">alias
+
<source lang="perl">$value = EPrints::Plugin->global_uri
  
 
</source>
 
</source>
Array reference of plugin id's that this plugin is aliasing (replacing).
+
Return a unique ID for this plugin, but not just in this repository but for any repository. This can be used for fuzzier tools which do not care about the minor differences between EPrints repositories.
 +
 
 +
This URL will not resolve to anything useful.
  
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
Line 78: Line 93:
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
$mime_type = EPrints::Plugin-&gt;mime_type()
+
<!-- Pod2Wiki=head_get_id -->
Returns the MIME type for this plugin.
+
===get_id===
  
Returns undef if there is no relevant MIME type for this plugin type.
+
<source lang="perl">$id = $plugin->get_id
  
$value = EPrints::Plugin-&gt;local_uri
+
</source>
Return a unique ID for this plugin as it relates to the current  repository. This can be used to distinguish that XML import for  different repositories may have minor differences.
+
Return the ID of this plugin.
  
This URL will not resolve to anything useful.
+
<!-- Edit below this comment -->
  
$value = EPrints::Plugin-&gt;global_uri
 
Return a unique ID for this plugin, but not just in this repository but for any repository. This can be used for fuzzier tools which do not care about the minor differences between EPrints repositories.
 
  
This URL will not resolve to anything useful.
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_name -->
 +
===get_name===
  
$id = $plugin-&gt;get_id
+
<source lang="perl">$name = $plugin->get_name
Return the ID of this plugin.
+
  
$name = $plugin-&gt;get_name
+
</source>
 
Return the ID of this plugin.
 
Return the ID of this plugin.
  
$name = $plugin-&gt;get_type
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_type -->
 +
===get_type===
 +
 
 +
<source lang="perl">$name = $plugin->get_type
 +
 
 +
</source>
 
Return the type of this plugin. eg. Export
 
Return the type of this plugin. eg. Export
  
$name = $plugin-&gt;get_subtype
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_subtype -->
 +
===get_subtype===
 +
 
 +
<source lang="perl">$name = $plugin->get_subtype
 +
 
 +
</source>
 
Return the sub-type of this plugin. eg. BibTex
 
Return the sub-type of this plugin. eg. BibTex
  
 
This is the ID with the type stripped from the front.
 
This is the ID with the type stripped from the front.
  
$msg = $plugin-&gt;error_message
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_error_message -->
 +
===error_message===
 +
 
 +
<source lang="perl">$msg = $plugin->error_message
 +
 
 +
</source>
 
Return the error message, if this plugin can't be used.
 
Return the error message, if this plugin can't be used.
  
$boolean = $plugin-&gt;broken
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_broken -->
 +
===broken===
 +
 
 +
<source lang="perl">$boolean = $plugin->broken
 +
 
 +
</source>
 
Return the value of a parameter in the current plugin.
 
Return the value of a parameter in the current plugin.
  
$name = $plugin-&gt;matches( $test, $param )
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_matches -->
 +
===matches===
 +
 
 +
<source lang="perl">$name = $plugin->matches( $test, $param )
 +
 
 +
</source>
 
Return true if this plugin matches the test, false otherwise. If the test is not known then return false.
 
Return true if this plugin matches the test, false otherwise. If the test is not known then return false.
  
$value = $plugin-&gt;param( $paramid )
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_param -->
 +
===param===
 +
 
 +
<source lang="perl">$value = $plugin->param( $paramid )
 +
 
 +
</source>
 
Return the parameter with the given id. This uses the hard wired parameter unless an override has been configured for this repository:
 
Return the parameter with the given id. This uses the hard wired parameter unless an override has been configured for this repository:
  
Line 122: Line 190:
 
   $c-&gt;{plugins}-&gt;{"Export::Ids"}-&gt;{params}-&gt;{disable} = 1;</pre>
 
   $c-&gt;{plugins}-&gt;{"Export::Ids"}-&gt;{params}-&gt;{disable} = 1;</pre>
  
$phraseid = $plugin-&gt;html_phrase_id( $id )
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_html_phrase_id -->
 +
===html_phrase_id===
 +
 
 +
<source lang="perl">$phraseid = $plugin->html_phrase_id( $id )
 +
 
 +
</source>
 
Returns the fully-qualified phrase identifier for the $id phrase for this plugin.
 
Returns the fully-qualified phrase identifier for the $id phrase for this plugin.
  
$xhtml = $plugin-&gt;html_phrase( $id, %bits )
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_html_phrase -->
 +
===html_phrase===
 +
 
 +
<source lang="perl">$xhtml = $plugin->html_phrase( $id, %bits )
 +
 
 +
</source>
 
Return the phrase belonging to this plugin, with the given id.
 
Return the phrase belonging to this plugin, with the given id.
  
 
Returns a DOM tree.
 
Returns a DOM tree.
  
$utf8 = $plugin-&gt;phrase( $id, %bits )
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_phrase -->
 +
===phrase===
 +
 
 +
<source lang="perl">$utf8 = $plugin->phrase( $id, %bits )
 +
 
 +
</source>
 
Return the phrase belonging to this plugin, with the given id.
 
Return the phrase belonging to this plugin, with the given id.
  
 
Returns a utf-8 encoded string.
 
Returns a utf-8 encoded string.
  
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki=head_copyright -->
 
<!-- Pod2Wiki=head_copyright -->
 
==COPYRIGHT==
 
==COPYRIGHT==

Revision as of 11:17, 2 April 2012

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Plugin - base class of all EPrints Plugins


SYNOPSIS

$plugin = $repo->plugin( "Export::XML" );


DESCRIPTION

This class provides the basic methods used by all EPrints Plugins.


METHODS

new

$plugin = EPrints::Plugin->new( %params );

Create a new instance of a plugin. Defines the following parameters:

  • repository
Required handle to the current repository object.
  • name
Human-readable name of the plugin.
  • alias
Array reference of plugin id's that this plugin is aliasing (replacing).


mime_type

$mime_type = EPrints::Plugin->mime_type()

Returns the MIME type for this plugin.

Returns undef if there is no relevant MIME type for this plugin type.


local_uri

$value = EPrints::Plugin->local_uri

Return a unique ID for this plugin as it relates to the current repository. This can be used to distinguish that XML import for different repositories may have minor differences.

This URL will not resolve to anything useful.


global_uri

$value = EPrints::Plugin->global_uri

Return a unique ID for this plugin, but not just in this repository but for any repository. This can be used for fuzzier tools which do not care about the minor differences between EPrints repositories.

This URL will not resolve to anything useful.


get_id

$id = $plugin->get_id

Return the ID of this plugin.


get_name

$name = $plugin->get_name

Return the ID of this plugin.


get_type

$name = $plugin->get_type

Return the type of this plugin. eg. Export


get_subtype

$name = $plugin->get_subtype

Return the sub-type of this plugin. eg. BibTex

This is the ID with the type stripped from the front.


error_message

$msg = $plugin->error_message

Return the error message, if this plugin can't be used.


broken

$boolean = $plugin->broken

Return the value of a parameter in the current plugin.


matches

$name = $plugin->matches( $test, $param )

Return true if this plugin matches the test, false otherwise. If the test is not known then return false.


param

$value = $plugin->param( $paramid )

Return the parameter with the given id. This uses the hard wired parameter unless an override has been configured for this repository:

  $c->{plugins}->{"Export::XML"}->{params}->{name} = "My EP3 XML";
  $c->{plugins}->{"Export::Ids"}->{params}->{disable} = 1;


html_phrase_id

$phraseid = $plugin->html_phrase_id( $id )

Returns the fully-qualified phrase identifier for the $id phrase for this plugin.


html_phrase

$xhtml = $plugin->html_phrase( $id, %bits )

Return the phrase belonging to this plugin, with the given id.

Returns a DOM tree.


phrase

$utf8 = $plugin->phrase( $id, %bits )

Return the phrase belonging to this plugin, with the given id.

Returns a utf-8 encoded string.


COPYRIGHT

Copyright 2000-2011 University of Southampton.

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 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/.