API:EPrints

From EPrints Documentation
Revision as of 13:05, 17 June 2010 by Tdb01r (talk | contribs)
Jump to: navigation, search

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 - Institutional Repository software

User Comments


SYNOPSIS

 use EPrints qw();
 
 $eprints = EPrints->new;
 
 # CLI
 $repo = $eprints->repository( "demoprints" );
 
 # CGI
 $repo = $eprints->current_repository;
 
 ...
 

User Comments


DESCRIPTION

See http://www.eprints.org/.

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


abort

EPrints->abort( $errmsg )

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

When running under Mod_Perl this method is replaced.

User Comments


new

$ep = EPrints->new();

Construct a new EPrints system object.

User Comments


repository

$repo = $ep->repository( $repository_id, %options );

Return the repository with the given ID, or undef. Options are... optional.

Options noise=>1, etc.

User Comments


current_repository

$repo = $ep->current_repository();

Returns the current repository.

Returns undef if there is no current repository active.

User Comments


repository_ids

@ids = $eprints->repository_ids

Returns a list of the active repository ids.

User Comments


SEE ALSO

EPrints::Repository

User Comments


COPYRIGHT

__COPYRIGHT__

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

__LICENSE__

User Comments