Difference between revisions of "API:EPrints/Repository"

From EPrints Documentation
Jump to: navigation, search
 
(25 intermediate revisions by 5 users not shown)
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=perl_lib/EPrints/Repository.pm|package_name=EPrints::Repository}}[[Category:API|REPOSITORY]][[Category:API:EPrints/Repository|REPOSITORY]]<div><!-- Edit below this comment -->
__NOTOC__
 
{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Repository.pm|package_name=EPrints::Repository}}[[Category:API|Repository]]<div><!-- Edit below this comment -->
 
  
  
<!-- Pod2Wiki=head_name --></div>
+
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
'''EPrints::Repository''' - A single eprint repository
+
EPrints::Repository - connection to a single repository instance
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_synopsis --></div>
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
  $repository = $handle-&gt;get_repository;
+
<source lang="perl">use EPrints;
 
+
 
  # without a $handle available
+
$repo = EPrints->new->current_repository;
  $repository = EPrints::Repository-&gt;new( $id, [$noxml] );
+
 
 
+
$repo = EPrints->new->repository( "myrepo" );
  $id = $repository-&gt;get_id;
+
 
  $dataset = $repository-&gt;get_dataset( $setname );
+
$xml = $repo->xml;
 
+
$cuser = $repo->current_user;
  $repository-&gt;log( $msg );
+
$repo->log( "Got user " . $cuser->id );</source>
 
+
 
  $confitem = $repository-&gt;get_conf( $key, [@subkeys] );
 
 
 
  # calling subtroutines in the config 
 
  $boolean = $repository-&gt;can_call( @cmd_conf_path );
 
  $result = $repository-&gt;call( $cmd, @params );
 
 
 
  # calling external commands
 
  $returncode = $repository-&gt;exec( $cmd_id, %map );
 
 
 
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_description --></div>
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
This class is a single eprint repository with its own configuration, database and website.
+
EPrints::Repository represents a connection to the EPrints system. It connects to a single EPrints repository, and the database used by that repository.
 +
 
 +
Each Repository has a "current language". If you are running in a  multilingual mode, this is used by the HTML rendering functions to choose what language to return text in.
 +
 
 +
The Repository object also knows about the current apache connection, if there is one, including the CGI parameters.
 +
 
 +
If the connection requires a username and password then it can also  give access to the [[API:EPrints/DataObj/User|EPrints::DataObj::User]] object representing the user who is causing this request. See [[API:EPrints/Repository#current_user|current_user]].
 +
 
 +
The Repository object provides access to the [[API:EPrints/XML|EPrints::XML]] and [[API:EPrints/XHTML|EPrints::XHTML]] class which contain methods for creating XHTML results which can be returned via the web interface.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 +
<!-- Pod2Wiki=head_new -->
 +
===new===
 +
 
 +
<source lang="perl">$repository = EPrints::Repository->new( %opts )
 +
 
 +
</source>
 +
Creates and returns a new repository object. This is a utility object only and will only have the basic system configuration available.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_new -->
 +
===new===
 +
 
 +
<source lang="perl">$repository = EPrints::Repository->new( $repository_id, %opts )
 +
 
 +
</source>
 +
Create a connection to an EPrints repository $repository_id which provides access to the database and to the repository configuration.
 +
 
 +
Options:
 +
 
 +
<pre>  db_connect - 1
 +
  check_db - 1
 +
  noise - 0</pre>
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_create_from_data -->
 +
===create_from_data===
 +
 
 +
<source lang="perl">$repo = EPrints::Repository->create_from_data( $epdata )
 +
 
 +
</source>
 +
Create a new repository instance using $epdata.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_delete -->
 +
===delete===
 +
 
 +
<source lang="perl">$repo->delete()
 +
 
 +
</source>
 +
Destroy the repository and all its contents.
 +
 
 +
To allow this method you must first set $EPrints::Repository::ALLOW_DELETE to 1.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_query -->
 +
===query===
 +
 
 +
<source lang="perl">$query = $repository->query
 +
 
 +
</source>
 +
Return the {{API:PodLink|file=CGI|package_name=CGI|section=|text=CGI}} object describing the current HTTP query, or  undefined if this isn't a CGI script.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_url_param -->
 +
===url_param===
 +
 
 +
<source lang="perl">$value or @values = $repository->url_param( $name )
 +
 
 +
</source>
 +
Retrieve the UTF-8 value(s) of the query parameter $name for the current request.
 +
 
 +
This will not cause the POST data to be read.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_param -->
 +
===param===
 +
 
 +
<source lang="perl">$value or @values = $repository->param( $name )
 +
 
 +
</source>
 +
Passes through to CGI.pm param method.
 +
 
 +
$value = $repository-&gt;param( $name ): returns the value of CGI parameter $name.
 +
 
 +
@values = $repository-&gt;param: returns an array of the names of all the CGI parameters in the current request.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_xml -->
 +
===xml===
 +
 
 +
<source lang="perl">$xml = $repo->xml
 +
 
 +
</source>
 +
Return an [[API:EPrints/XML|EPrints::XML]] object for working with XML.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_xhtml -->
 +
===xhtml===
 +
 
 +
<source lang="perl">$xhtml = $repo->xhtml
 +
 
 +
</source>
 +
Return an [[API:EPrints/XHTML|EPrints::XHTML]] object for working with XHTML.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_eprint -->
 +
===eprint===
 +
 
 +
<source lang="perl">$eprint = $repository->eprint( $eprint_id );
 +
 
 +
</source>
 +
A convience method to return the [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]] with  the given ID, or undef.
 +
 
 +
Equivent to $repository-&gt;dataset("eprint")-&gt;dataobj( $eprint_id )
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_current_language -->
 +
===current_language===
 +
 
 +
<source lang="perl">$lang = $repository->current_language
 +
 
 +
</source>
 +
Returns the current language.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_current_user -->
 +
===current_user===
 +
 
 +
<source lang="perl">$user = $repository->current_user
 +
 
 +
</source>
 +
Return the current logged in [[API:EPrints/DataObj/User|EPrints::DataObj::User]] for this session.
 +
 
 +
Return undef if there isn't one.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_user -->
 +
===user===
 +
 
 +
<source lang="perl">$user = $repository->user( $user_id );
 +
 
 +
</source>
 +
A convience method to return the [[API:EPrints/DataObj/User|EPrints::DataObj::User]] with the given ID, or undef.
 +
 
 +
Equivent to $repository-&gt;dataset("user")-&gt;dataobj( $user_id )
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_new --></div>
+
<!-- Pod2Wiki= -->
===$repository = EPrints::Repository-&gt;new( $id, [$noxml] )===
+
<!-- Pod2Wiki=head_user_by_username -->
 +
===user_by_username===
  
Returns the repository with the given repository ID. If $noxml is specified then it skips loading the XML based configuration files (this is needed when creating an repository as it first has to create the DTD files, and if it can't start you have a catch 22 situtation).
+
<source lang="perl">$user = $repository->user_by_username( $username );
  
This constructor should only be used if you don't want to create a  EPrints::Handle for some reason.
+
</source>
 +
Return the user with the given username, or undef.
  
In a CGI context, creating a handle will link it to an existing  EPrints::Repository object, whereas calling this constructor will  cause all the config files to be read specially for you. (much slower!)
+
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_user_by_email -->
 +
===user_by_email===
 +
 
 +
<source lang="perl">$user = $repository->user_by_email( $email );
 +
 
 +
</source>
 +
Return the [[API:EPrints/DataObj/User|EPrints::DataObj::User]] with the given email, or undef.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_dataset_ids --></div>
+
<!-- Pod2Wiki= -->
===@dataset_ids = $repository-&gt;get_dataset_ids()===
+
<!-- Pod2Wiki=head_template -->
 +
===template===
  
Returns a list of dataset ids in this repository.
+
<source lang="perl">$template = $repository->template( [ $id ] )
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
</source>
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_dataset --></div>
+
<!-- Pod2Wiki= -->
===$dataset = $repository-&gt;get_dataset( $setname )===
+
<!-- Pod2Wiki=head_dataset -->
 +
===dataset===
  
Returns the cached EPrints::DataSet with the given dataset id name.
+
<source lang="perl">$dataset = $repository->dataset( $setname )
 +
 
 +
</source>
 +
Return a given [[API:EPrints/DataSet|EPrints::DataSet]] or undef if it doesn't exist.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_conf --></div>
+
<!-- Pod2Wiki= -->
===$confitem = $repository-&gt;get_conf( $key, [@subkeys] )===
+
<!-- Pod2Wiki=head_config -->
 +
===config===
 +
 
 +
<source lang="perl">$confitem = $repository->config( $key, [@subkeys] )
  
Returns a named configuration setting.  
+
</source>
 +
Returns a named configuration setting including those defined in archvies/&lt;archive_id&gt;/cfg/cfg.d/
  
$repository-&gt;get_conf( "stuff", "en", "foo" )
+
$repository-&gt;config( "stuff", "en", "foo" )
  
 
is equivalent to  
 
is equivalent to  
  
$repository-&gt;get_conf( "stuff" )-&gt;{en}-&gt;{foo}  
+
$repository-&gt;config( "stuff" )-&gt;{en}-&gt;{foo}  
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_log --></div>
+
<!-- Pod2Wiki= -->
===$repository-&gt;log( $msg )===
+
<!-- Pod2Wiki=head_log -->
 +
===log===
 +
 
 +
<source lang="perl">$repository->log( $msg [, $level ] )
  
Calls the log method from ArchiveConfig.pm for this repository with the given parameters. Basically logs the comments wherever the site admin wants them to go. Printed to STDERR by default.
+
</source>
 +
Log a plain text message $msg. If $level is given only logs if $level is greater than or equal to [[API:EPrints/Repository#noise|noise]].
 +
 
 +
To override where log messages are sent define the <code>log</code> callback:
 +
 
 +
<pre> $c-&gt;{log} = sub {
 +
    my( $repo, $msg, $level ) = @_;
 +
 
 +
    ...
 +
  };</pre>
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_call --></div>
+
<!-- Pod2Wiki= -->
===$result = $repository-&gt;call( $cmd, @params )===
+
<!-- Pod2Wiki=head_call -->
 +
===call===
  
 +
<source lang="perl">$result = $repository->call( $cmd, @params )
 +
 +
</source>
 
Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.
 
Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_can_call --></div>
+
<!-- Pod2Wiki= -->
===$boolean = $repository-&gt;can_call( @cmd_conf_path )===
+
<!-- Pod2Wiki=head_can_call -->
 +
===can_call===
 +
 
 +
<source lang="perl">$boolean = $repository->can_call( @cmd_conf_path )
  
 +
</source>
 
Return true if the given subroutine exists in this repository's config package.
 
Return true if the given subroutine exists in this repository's config package.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_id --></div>
+
<!-- Pod2Wiki= -->
===$id = $repository-&gt;get_id ===
+
<!-- Pod2Wiki=head_try_call -->
 +
===try_call===
 +
 
 +
<source lang="perl">$result = $repository->try_call( $cmd, @params )
 +
 
 +
</source>
 +
Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.
 +
 
 +
If the subroutine does not exist then quietly returns undef.
 +
 
 +
This is used to call deprecated callback subroutines.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_template_dirs -->
 +
===template_dirs===
 +
 
 +
<source lang="perl">@dirs = $repository->template_dirs( $langid )
 +
 
 +
</source>
 +
Returns a list of directories from which template files may be sourced, where the first matching template encountered is used.
 +
 
 +
The directories searched are:
  
 +
<pre>  archives/[archiveid]/cfg/lang/[langid]/templates/
 +
  archives/[archiveid]/cfg/templates/
 +
  archives/[archiveid]/cfg/themes/[themeid]/lang/[langid]/templates/
 +
  archives/[archiveid]/cfg/themes/[themeid]/templates/
 +
  lib/themes/[themeid]/templates/
 +
  lib/lang/[langid]/templates/
 +
  lib/templates/</pre>
 +
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_static_dirs -->
 +
===get_static_dirs===
 +
 +
<source lang="perl">@dirs = $repository->get_static_dirs( $langid )
 +
 +
</source>
 +
Returns a list of directories from which static files may be sourced.
 +
 +
Directories are returned in order of importance, most important first:
 +
 +
<pre>  archives/[archiveid]/cfg/lang/[langid]/static
 +
  archives/[archiveid]/cfg/static
 +
  archives/[archiveid]/themes/[themeid]/static
 +
  lib/themes/[themeid]/static
 +
  lib/lang/[langid]/static
 +
  lib/static</pre>
 +
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_id -->
 +
===id===
 +
 +
<source lang="perl">$id = $repository->id
 +
 +
</source>
 
Returns the id string of this repository.
 
Returns the id string of this repository.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_exec --></div>
+
<!-- Pod2Wiki= -->
===$returncode = $repository-&gt;exec( $cmd_id, %map )===
+
<!-- Pod2Wiki=head_exec -->
 +
===exec===
  
 +
<source lang="perl">$returncode = $repository->exec( $cmd_id, %map )
 +
 +
</source>
 
Executes a system command. $cmd_id is the id of the command as set in SystemSettings and %map contains a list of things to "fill in the blanks" in the invocation line in SystemSettings.  
 
Executes a system command. $cmd_id is the id of the command as set in SystemSettings and %map contains a list of things to "fill in the blanks" in the invocation line 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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_test_config -->
 +
===test_config===
 +
 
 +
<source lang="perl">( $returncode, $output) = $repository->test_config
 +
 
 +
</source>
 +
This runs "epadmin test" as an external script to test if the current configuraion on disk loads OK. This can be used by the web interface to test if changes to config. files may be saved, or not.
 +
 
 +
$returncode will be zero if everything seems OK.
 +
 
 +
If not, then $output will contain the output of epadmin test
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_reload_config -->
 +
===reload_config===
 +
 
 +
<source lang="perl">$ok = $repository->reload_config
 +
 
 +
</source>
 +
Trigger a configuration reload on the next request/index.
 +
 
 +
To reload the configuration right now just call [[API:EPrints/Repository#load_config|load_config]].
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_html_phrase -->
 +
===html_phrase===
 +
 
 +
<source lang="perl">$xhtml_phrase = $repository->html_phrase( $phraseid, %inserts )
 +
 
 +
</source>
 +
Return an XHTML DOM object describing a phrase from the phrase files.
 +
 
 +
$phraseid is the id of the phrase to return. If the same ID appears in both the repository-specific phrases file and the system phrases file then the repository-specific one is used.
 +
 
 +
If the phrase contains &lt;ep:pin&gt; elements, then each one should have an entry in %inserts where the key is the "ref" of the pin and the value is an XHTML DOM object describing what the pin should be  replaced with.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_phrase -->
 +
===phrase===
 +
 
 +
<source lang="perl">$utf8_text = $repository->phrase( $phraseid, %inserts )
 +
 
 +
</source>
 +
Performs the same function as html_phrase, but returns plain text.
 +
 
 +
All HTML elements will be removed, &lt;br&gt; and &lt;p&gt; will be converted  into breaks in the text. &lt;img&gt; tags will be replaced with their  "alt" values.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_noise -->
 +
===noise===
 +
 
 +
<source lang="perl">$noise_level = $repository->noise
 +
 
 +
</source>
 +
Return the noise level for the current session. See the explaination under EPrints::Repository-&gt;new()
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_plugins -->
 +
===plugins===
 +
 
 +
<source lang="perl">@plugins = $repository->plugins( [ $params, ] %restrictions )
 +
 
 +
</source>
 +
Returns a list of plugin objects that conform to %restrictions (may be empty).
 +
 
 +
If $params is given uses that hash reference to initialise the plugins. Always passes this session to the plugin constructor method.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_init_from_indexer -->
 +
===init_from_indexer===
 +
 
 +
<source lang="perl">$repo->init_from_indexer( $daemon )
 +
 
 +
</source>
 +
(Re)initialise the repository object for use by the indexer.
 +
 
 +
Calls [[API:EPrints/Repository#check_last_changed|check_last_changed]].
 +
 
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
Copyright 2000-2011 University of Southampton.
 +
 
 +
This file is part of EPrints http://www.eprints.org/.
 +
 
 +
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 +
 
 +
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 +
 
 +
You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=_postamble_ -->
 +
<!-- Edit below this comment -->

Latest revision as of 14:39, 30 July 2013

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::Repository - connection to a single repository instance


SYNOPSIS

use EPrints;

$repo = EPrints->new->current_repository;

$repo = EPrints->new->repository( "myrepo" );

$xml = $repo->xml;
$cuser = $repo->current_user;
$repo->log( "Got user " . $cuser->id );


DESCRIPTION

EPrints::Repository represents a connection to the EPrints system. It connects to a single EPrints repository, and the database used by that repository.

Each Repository has a "current language". If you are running in a multilingual mode, this is used by the HTML rendering functions to choose what language to return text in.

The Repository object also knows about the current apache connection, if there is one, including the CGI parameters.

If the connection requires a username and password then it can also give access to the EPrints::DataObj::User object representing the user who is causing this request. See current_user.

The Repository object provides access to the EPrints::XML and EPrints::XHTML class which contain methods for creating XHTML results which can be returned via the web interface.


METHODS

new

$repository = EPrints::Repository->new( %opts )

Creates and returns a new repository object. This is a utility object only and will only have the basic system configuration available.


new

$repository = EPrints::Repository->new( $repository_id, %opts )

Create a connection to an EPrints repository $repository_id which provides access to the database and to the repository configuration.

Options:

  db_connect - 1
  check_db - 1
  noise - 0


create_from_data

$repo = EPrints::Repository->create_from_data( $epdata )

Create a new repository instance using $epdata.


delete

$repo->delete()

Destroy the repository and all its contents.

To allow this method you must first set $EPrints::Repository::ALLOW_DELETE to 1.


query

$query = $repository->query

Return the CGI object describing the current HTTP query, or undefined if this isn't a CGI script.


url_param

$value or @values = $repository->url_param( $name )

Retrieve the UTF-8 value(s) of the query parameter $name for the current request.

This will not cause the POST data to be read.


param

$value or @values = $repository->param( $name )

Passes through to CGI.pm param method.

$value = $repository->param( $name ): returns the value of CGI parameter $name.

@values = $repository->param: returns an array of the names of all the CGI parameters in the current request.


xml

$xml = $repo->xml

Return an EPrints::XML object for working with XML.


xhtml

$xhtml = $repo->xhtml

Return an EPrints::XHTML object for working with XHTML.


eprint

$eprint = $repository->eprint( $eprint_id );

A convience method to return the EPrints::DataObj::EPrint with the given ID, or undef.

Equivent to $repository->dataset("eprint")->dataobj( $eprint_id )


current_language

$lang = $repository->current_language

Returns the current language.


current_user

$user = $repository->current_user

Return the current logged in EPrints::DataObj::User for this session.

Return undef if there isn't one.


user

$user = $repository->user( $user_id );

A convience method to return the EPrints::DataObj::User with the given ID, or undef.

Equivent to $repository->dataset("user")->dataobj( $user_id )


user_by_username

$user = $repository->user_by_username( $username );

Return the user with the given username, or undef.


user_by_email

$user = $repository->user_by_email( $email );

Return the EPrints::DataObj::User with the given email, or undef.


template

$template = $repository->template( [ $id ] )


dataset

$dataset = $repository->dataset( $setname )

Return a given EPrints::DataSet or undef if it doesn't exist.


config

$confitem = $repository->config( $key, [@subkeys] )

Returns a named configuration setting including those defined in archvies/<archive_id>/cfg/cfg.d/

$repository->config( "stuff", "en", "foo" )

is equivalent to

$repository->config( "stuff" )->{en}->{foo}


log

$repository->log( $msg [, $level ] )

Log a plain text message $msg. If $level is given only logs if $level is greater than or equal to noise.

To override where log messages are sent define the log callback:

  $c->{log} = sub {
    my( $repo, $msg, $level ) = @_;
  
    ...
  };


call

$result = $repository->call( $cmd, @params )

Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.


can_call

$boolean = $repository->can_call( @cmd_conf_path )

Return true if the given subroutine exists in this repository's config package.


try_call

$result = $repository->try_call( $cmd, @params )

Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.

If the subroutine does not exist then quietly returns undef.

This is used to call deprecated callback subroutines.


template_dirs

@dirs = $repository->template_dirs( $langid )

Returns a list of directories from which template files may be sourced, where the first matching template encountered is used.

The directories searched are:

  archives/[archiveid]/cfg/lang/[langid]/templates/
  archives/[archiveid]/cfg/templates/
  archives/[archiveid]/cfg/themes/[themeid]/lang/[langid]/templates/
  archives/[archiveid]/cfg/themes/[themeid]/templates/
  lib/themes/[themeid]/templates/
  lib/lang/[langid]/templates/
  lib/templates/


get_static_dirs

@dirs = $repository->get_static_dirs( $langid )

Returns a list of directories from which static files may be sourced.

Directories are returned in order of importance, most important first:

  archives/[archiveid]/cfg/lang/[langid]/static
  archives/[archiveid]/cfg/static
  archives/[archiveid]/themes/[themeid]/static
  lib/themes/[themeid]/static
  lib/lang/[langid]/static
  lib/static


id

$id = $repository->id

Returns the id string of this repository.


exec

$returncode = $repository->exec( $cmd_id, %map )

Executes a system command. $cmd_id is the id of the command as set in SystemSettings and %map contains a list of things to "fill in the blanks" in the invocation line in SystemSettings.


test_config

( $returncode, $output) = $repository->test_config

This runs "epadmin test" as an external script to test if the current configuraion on disk loads OK. This can be used by the web interface to test if changes to config. files may be saved, or not.

$returncode will be zero if everything seems OK.

If not, then $output will contain the output of epadmin test


reload_config

$ok = $repository->reload_config

Trigger a configuration reload on the next request/index.

To reload the configuration right now just call load_config.


html_phrase

$xhtml_phrase = $repository->html_phrase( $phraseid, %inserts )

Return an XHTML DOM object describing a phrase from the phrase files.

$phraseid is the id of the phrase to return. If the same ID appears in both the repository-specific phrases file and the system phrases file then the repository-specific one is used.

If the phrase contains <ep:pin> elements, then each one should have an entry in %inserts where the key is the "ref" of the pin and the value is an XHTML DOM object describing what the pin should be replaced with.


phrase

$utf8_text = $repository->phrase( $phraseid, %inserts )

Performs the same function as html_phrase, but returns plain text.

All HTML elements will be removed, <br> and <p> will be converted into breaks in the text. <img> tags will be replaced with their "alt" values.


noise

$noise_level = $repository->noise

Return the noise level for the current session. See the explaination under EPrints::Repository->new()


plugins

@plugins = $repository->plugins( [ $params, ] %restrictions )

Returns a list of plugin objects that conform to %restrictions (may be empty).

If $params is given uses that hash reference to initialise the plugins. Always passes this session to the plugin constructor method.


init_from_indexer

$repo->init_from_indexer( $daemon )

(Re)initialise the repository object for use by the indexer.

Calls check_last_changed.

COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.