API:EPrints: Difference between revisions
No edit summary |
No edit summary |
||
| Line 95: | Line 95: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_abort --> | <!-- Pod2Wiki=item_abort --> | ||
=== | ===abort=== | ||
EPrints->abort( $errmsg ) | |||
Print an error message and exit. If running under mod_perl then print the error as a webpage and exit. | Print an error message and exit. If running under mod_perl then print the error as a webpage and exit. | ||
| Line 109: | Line 110: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_new --> | <!-- Pod2Wiki=item_new --> | ||
=== | ===new=== | ||
$ep = EPrints->new(); | |||
Construct a new EPrints system object. | Construct a new EPrints system object. | ||
| Line 121: | Line 123: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_repository --> | <!-- Pod2Wiki=item_repository --> | ||
=== | ===repository=== | ||
$repo = $ep->repository( $repository_id, %options ); | |||
Return the repository with the given ID, or undef. Options are... optional. | Return the repository with the given ID, or undef. Options are... optional. | ||
| Line 135: | Line 138: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_current_repository --> | <!-- Pod2Wiki=item_current_repository --> | ||
=== | ===current_repository=== | ||
$repo = $ep->current_repository( %options ); | |||
Return the repository based on the current web request, or undef. | Return the repository based on the current web request, or undef. | ||
| Line 149: | Line 153: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_repository_ids --> | <!-- Pod2Wiki=item_repository_ids --> | ||
=== | ===repository_ids=== | ||
@ids = $eprints->repository_ids | |||
Returns a list of the active repository ids. | Returns a list of the active repository ids. | ||
| Line 162: | Line 167: | ||
<!-- Pod2Wiki=head_see_also --> | <!-- Pod2Wiki=head_see_also --> | ||
==SEE ALSO== | ==SEE ALSO== | ||
[[API:EPrints/ | [[API:EPrints/Repository|EPrints::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 13:21, 25 February 2010
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
NAME
EPrints - Institutional Repository software
SYNOPSIS
use EPrints qw(); my $session = EPrints::Session->new( 1, "demoprints" ); ... $session->terminate;
DESCRIPTION
Available Symbols
You can pass options to the EPrints package that effect the EPrints initialisation e.g.
use EPrints qw( no_check_user );
no_check_user
Do not check the current user/group is the same as the user/group in Systemsettings.
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.
METHODS
abort
EPrints->abort( $errmsg )
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.
new
$ep = EPrints->new();
Construct a new EPrints system object.
repository
$repo = $ep->repository( $repository_id, %options );
Return the repository with the given ID, or undef. Options are... optional.
Options noise=>1, etc.
current_repository
$repo = $ep->current_repository( %options );
Return the repository based on the current web request, or undef.
%options as for $ep->repository(..)
repository_ids
@ids = $eprints->repository_ids
Returns a list of the active repository ids.
SEE ALSO
COPYRIGHT
__COPYRIGHT__
Copyright 2000-2008 University of Southampton. All Rights Reserved.
__LICENSE__