Difference between revisions of "API:EPrints"

From EPrints Documentation
Jump to: navigation, search
Line 18: Line 18:
 
==SYNOPSIS==
 
==SYNOPSIS==
 
   use EPrints qw();
 
   use EPrints qw();
 +
 
 +
  # don't check current user (CLI only)
 +
  use EPrints qw( no_check_user );
 
    
 
    
 
   $eprints = EPrints->new;
 
   $eprints = EPrints->new;
Line 27: Line 30:
 
   $repo = $eprints->current_repository;
 
   $repo = $eprints->current_repository;
 
    
 
    
   ...
+
   if( EPrints->VERSION() gt v3.2.0 )
 +
  {
 +
    ...
 +
  }
 
    
 
    
 
<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%; '>
Line 64: Line 70:
  
 
Do not check the current user/group is the same as the user/group in SystemSettings.
 
Do not check the current user/group is the same as the user/group in SystemSettings.
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=head_debugging_slow_processes -->
 
===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.
 
  
 
<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%; '>
Line 156: Line 145:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
<!-- Pod2Wiki=item_repository_ids -->
+
<!-- Pod2Wiki=item_version -->
===repository_ids===
+
===version===
  
  @ids = $eprints-&gt;repository_ids
+
  $version = EPrints-&gt;VERSION()
Returns a list of the active repository ids.
+
Returns the version of EPrints in 'v' format.
  
 
<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 17:26, 31 December 2010

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();
 
 # don't check current user (CLI only)
 use EPrints qw( no_check_user );
 
 $eprints = EPrints->new;
 
 # CLI
 $repo = $eprints->repository( "demoprints" );
 
 # CGI
 $repo = $eprints->current_repository;
 
 if( EPrints->VERSION() gt v3.2.0 )
 {
   ...
 }
 

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


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


version

$version = EPrints->VERSION()

Returns the version of EPrints in 'v' format.

User Comments


SEE ALSO

EPrints::Repository

User Comments


COPYRIGHT

__COPYRIGHT__

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

__LICENSE__

User Comments