Difference between revisions of "API:EPrints"

From EPrints Documentation
Jump to: navigation, search
Line 22: Line 22:
 
   use strict;
 
   use strict;
 
    
 
    
−
   my $handle = new EPrints::Handle( 1 , 'my_repository_id' );
+
  # cgi script 
 +
   my $handle = EPrints->get_handle();
 
   exit( 1 ) unless( defined $handle );
 
   exit( 1 ) unless( defined $handle );
 
    
 
    
−
   $eprint = new EPrints::DataObj::EPrint( $handle, 23 );
+
   # bin script
 +
  my $handle = EPrints->get_handle( repository => $repository_id, noise => $noise );
 +
  exit( 1 ) unless( defined $handle );
 +
 
 +
  $eprint = $handle->get_eprint( $eprintid );
 
   my $title = $eprint->get_value( 'title' );
 
   my $title = $eprint->get_value( 'title' );
 
    
 
    
Line 442: Line 447:
  
 
This subroutine is loaded before other modules so that it may be used to report errors when initialising modules.
 
This subroutine is loaded before other modules so that it may be used to report errors when initialising modules.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<h4><span style='display:none'>User Comments</span></h4>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki=item_get_handle --></div>
 +
===$handle = EPrints-&gt;get_handle( %options )===
 +
 +
Return an EPrints::Handle object joining a web request or script to a database connection, and the configuration and data for a single  repository.
 +
 +
The main options are:
 +
 +
repository =&gt; $repository_id: This is required for command line scripts. CGI scripts will obtain the repository ID from the context of the request.
 +
 +
noise =&gt; [0..4]: The level of debug info. 0 - silent, 1 - quietish (default), 2 - noisy, 3 - debug all SQL statements, 4 - debug database connection.
 +
 +
The following advanced options are also available but are less likely to be useful:
 +
 +
consume_post_data =&gt; [0,1]: Default 1. Only meaningful when running as a web-request. Setting this to "0" will stop the session parsing the POST data which comes in via STDIN. This may be useful if writing apache handlers which make decisions before the main $handle is created. If you don't set it they consume the POST data, and the main handle doesn't get to see it.
 +
 +
check_database =&gt; [0,1]: Default 1. By default a session checks the database structure is compatible with the EPrints database module version. Setting this to "0" will supress this check. =cut ######################################################################
 +
 +
sub get_handle {
 +
my( $class, %options ) = @_;
 +
 +
  return EPrints::Handle-&gt;new( %options ); }
 +
 
 +
###################################################################### =pod
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<h4><span style='display:none'>User Comments</span></h4>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki=item_get_repository --></div>
 +
===$repository = EPrints-&gt;get_repository( $repository_id )===
 +
 +
Return an EPrints::Repository object representing the configuration of the named repository.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Revision as of 19:13, 25 August 2009


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.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints - Institutional Repository software

User Comments


SYNOPSIS

 #!/usr/bin/perl -w -I/opt/eprints3/perl_lib
 
 use EPrints;
 use strict;
 
 # cgi script  
 my $handle = EPrints->get_handle();
 exit( 1 ) unless( defined $handle );
 
 # bin script
 my $handle = EPrints->get_handle( repository => $repository_id, noise => $noise );
 exit( 1 ) unless( defined $handle );
 
 $eprint = $handle->get_eprint( $eprintid );
 my $title = $eprint->get_value( 'title' );
 
 $eprint->set_value( 'creators', 
   [
     { 
       name => { given=>'John', family=>'Smith' },
       id => 'js@example.com',
     },
     { 
       name => { given=>'Marvin', family=>'Fenderson' },
       id => 'marvin@totl.net',
     },
   ]
 );
 $eprint->commit;
 
 my $eprint_ds = $handle->get_dataset( "eprint" );
 my $new_eprint = $eprint_ds->create_object( 
   $handle, { title=>"My new EPrint!" } );
 
 my $archive_ds = $handle->get_dataset( "archive" );
 my $search = new EPrints::Search( 
   handle => $handle, 
   dataset => $archive_ds );
 my $date_mf = $archive_ds->get_field( "date" );
 $search->add_field( $date_mf, "2000-2003" );
 
 my $list = $search->perform_search;
 $list->map(
   sub {
     my( $handle, $dataset, $eprint, $info ) = @_;
 
     printf( "%s: %s\n", 
        $eprint->get_value( "date" ),
        $eprint->get_value( "title" ) );
   }
 );
 $list->dispose();
 
 $handle->log( "We did some stuff." );
 
 if( some_test() ) { EPrints::abort( "Something bad happened" ); }
 
 $handle->terminate;

User Comments


DESCRIPTION

Using this module will cause all the other EPrints modules to be used also.

See http://www.eprints.org/ for more information about EPrints. Much more documentation can be found at http://wiki.eprints.org/w/Documentation

User Comments


Key API EPrints Modules

User Comments


EPrints

This module! Used to load the other modules.

User Comments


EPrints::DataObj

Abstract object representing a single record in a DataSet. Has one subclass for each type of DataSet. The most important subclasses are listed below. This module documents generic functions which work on all (or most) data objects. Every DataObj has a unique ID within the dataset (an integer, with the exception of Subject). Every DataObj is given a URI of the form repository_url/id/datasetid/dataobj_id

User Comments


EPrints::DataObj::Document

Represents a single document. A document is a set of metadata plus files. It *may* have some repository configuraed metadata in addition to the default. The metadata describes the document and is mostly concerned with formats, and rights. Documents belong to exactly one EPrints::DataObj::EPrint are are destroyed if it is destroyed. A document has one or more file. If there's more than one file then they are related, like a .css file for a .html

User Comments


EPrints::DataObj::EPrint

Represents a single submission to the repository. May have 0+ documents as sub-objects. Has both system defined metafields plus many defined in the repository configuration.

User Comments


EPrints::DataSet

This object represents a set of objects of the same time, and has associated MetaFields and database tables. A dataset may represent a subset of another dataset. For example, "eprint" represents all EPrints::DataObj::EPrint objects, but the "buffer" dataset only represents those which are "under review".

User Comments


EPrints::Handle

the core of the EPrints API. This object represents a connection between the configuration for a repository, the database connection and either the CGI (web) or CLI (command line) interface.

Handle has a large number of methods, which are documented in more than one file:

User Comments


EPrints::Handle::Language

Handle methods for i18n.

User Comments


EPrints::Handle::Render

Handle methods for generating XHTML as XML::DOM objects.

User Comments


EPrints::Handle::CGI

Handle methods for working with the mod_perl connection.

User Comments


EPrints::Handle::Page

Handle methods for generating and serving XHTML web pages.

User Comments


EPrints::Handle::XML

Handle methods for creating XML::DOM objects.

User Comments


EPrints::List

A list of zero or more data-objects in a single dataset. It can be constructed from a list of ID's or returned as the result of a search.

User Comments


EPrints::MetaField

A single field in a dataset. It has many subclasses, one for each type of field.

User Comments


EPrints::Repository

Represents the configuration, datasets and dataobjects of a single repository. It is loaded from the configuration files and is essentially read-only.

User Comments


EPrints::Search

The search object takes parameters and returns a List object of matching dataobjs from a given dataset. It can also be used it reverse to test if a dataobj matches it's parameters.

User Comments


Other API EPrints Modules

User Comments


EPrints::Box

A utitility module to render HTML boxes with style and javascript roll-up animations.

User Comments


EPrints::Database

An object representing a connection to the database for a repository. This is an abstraction over sub-objects which connect to MySQL or Oracle.

User Comments


EPrints::DataObj::File

Represents a single file in a document with some basic metadata such as checksums.

User Comments


EPrints::DataObj::User

Represents a single registered user of the repository. Used for keeping track of preferences, profile information and rights management.

User Comments


EPrints::DataObj::Subject

This dataset is used to store the structure of heierachichal(sp?) sets, used by the "Subject" metafield type.

User Comments


EPrints::Email

Tool for sending email.

User Comments


EPrints::Paginate

Tools for rendering an EPrint::List as paginated HTML.

User Comments


EPrints::Paginate::Columns

An extension to EPrints::Paginate which shows the results in sortable columns, as seen in Items and Review screens.

User Comments


EPrints::Storage

Methods to abstract the process of reading and writing files. EPrints 3.2 introduced the possibility of storing files in the cloud, or in other storage devices, and this module is the interface to that.

User Comments


EPrints::TempDir

Tools for creating and destorying temporary directories.

User Comments


EPrints::Time

A set of methods for handling time and converting between time formats.

User Comments


EPrints::URL

Utility methods for generating and getting URLs, relative paths etc.

User Comments


EPrints::Utils

Misc. utility methods.

User Comments


EPrints::XML

Utility methods for working with XML and DOM. This papers over the cracks between the 3 different XML DOM libraries EPrints supports.

User Comments


Available Symbols

You can pass options to the EPrints package that effect the EPrints initialisation e.g. 

 use EPrints qw( no_check_user );

User Comments


no_check_user

Do not check the current user/group is the same as the user/group in Systemsettings.

User Comments


Debugging Slow Processes

This module installs a signal handler that will print a stack trace if given a USR2 signal (if your system supports this signal). To print a stack trace to the error log execute: 

$ kill -USR2 PID

Where PID is the id number of the stalled process.

A shell script will print the stack trace to the console.

User Comments


METHODS

User Comments


EPrints::abort( $msg )

Print an error message and exit. If running under mod_perl then print the error as a webpage and exit.

This subroutine is loaded before other modules so that it may be used to report errors when initialising modules.

User Comments


$handle = EPrints->get_handle( %options )

Return an EPrints::Handle object joining a web request or script to a database connection, and the configuration and data for a single repository.

The main options are:

repository => $repository_id: This is required for command line scripts. CGI scripts will obtain the repository ID from the context of the request.

noise => [0..4]: The level of debug info. 0 - silent, 1 - quietish (default), 2 - noisy, 3 - debug all SQL statements, 4 - debug database connection.

The following advanced options are also available but are less likely to be useful:

consume_post_data => [0,1]: Default 1. Only meaningful when running as a web-request. Setting this to "0" will stop the session parsing the POST data which comes in via STDIN. This may be useful if writing apache handlers which make decisions before the main $handle is created. If you don't set it they consume the POST data, and the main handle doesn't get to see it.

check_database => [0,1]: Default 1. By default a session checks the database structure is compatible with the EPrints database module version. Setting this to "0" will supress this check. =cut ######################################################################

sub get_handle { my( $class, %options ) = @_; 

 return EPrints::Handle->new( %options ); }
                                                                                                                                            1. =pod

User Comments


$repository = EPrints->get_repository( $repository_id )

Return an EPrints::Repository object representing the configuration of the named repository.

User Comments


SEE ALSO

EPrints::Handle

User Comments


COPYRIGHT

__COPYRIGHT__

Copyright 2000-2008 University of Southampton. All Rights Reserved.

__LICENSE__

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints&oldid=7293’