Difference between revisions of "API:EPrints"

From EPrints Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints.pm|package_name=EPrints}}[[Category:API|EPRINTS]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints|package_name=EPrints}}[[Category:API|EPRINTS]]<div><!-- Edit below this comment -->
  
  

Revision as of 15:25, 16 December 2011

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


version

$version = EPrints->VERSION()

Returns the version of EPrints in 'v' format (this is the UNIVERSAL method).

User Comments


human_version

EPrints->human_version()

Returns the EPrints version in a human-readable form.

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


dump

EPrints->dump( $VAR1 [, $VAR2 ... ] )

Use Data::Dumper to dump the passed variables to STDERR.

User Comments


new

$ep = EPrints->new();

Construct a new EPrints system object.

User Comments


repository

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

Return the EPrints::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 EPrints::Repository. The current repository is determined by the apache request.

Returns undef if there is no current repository active.

User Comments


SEE ALSO

EPrints::Repository

User Comments


COPYRIGHT

User Comments