Difference between revisions of "API:EPrints/Repository"

From EPrints Documentation
Jump to: navigation, search
Line 62: Line 62:
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
* $query = $repository-&gt;query
+
<!-- Pod2Wiki=head_query -->
: 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.
+
===query===
  
* $value or @values = $repository-&gt;param( $name )
+
<source lang="perl">$query = $repository->query
: Passes through to CGI.pm param method.
+
  
: $value = $repository-&gt;param( $name ): returns the value of CGI parameter $name.
+
</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.
  
: $value = $repository-&gt;param( $name ): returns the value of CGI parameter $name.
+
<!-- Edit below this comment -->
  
: @values = $repository-&gt;param: returns an array of the names of all the CGI parameters in the current request.
 
  
* $xml = $repo-&gt;xml
+
<!-- Pod2Wiki= -->
: Return an [[API:EPrints/XML|EPrints::XML]] object for working with XML.
+
<!-- Pod2Wiki=head_param -->
 +
===param===
  
* $xhtml = $repo-&gt;xhtml
+
<source lang="perl">$value or @values = $repository->param( $name )
: Return an [[API:EPrints/XHTML|EPrints::XHTML]] object for working with XHTML.
+
  
* $eprint = $repository-&gt;eprint( $eprint_id );
+
</source>
: A convience method to return the [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]] with  the given ID, or undef.
+
Passes through to CGI.pm param method.
  
: Equivent to $repository-&gt;dataset("eprint")-&gt;dataobj( $eprint_id )
+
$value = $repository-&gt;param( $name ): returns the value of CGI parameter $name.
  
* $user = $repository-&gt;current_user
+
$value = $repository-&gt;param( $name ): returns the value of CGI parameter $name.
: Return the current logged in [[API:EPrints/DataObj/User|EPrints::DataObj::User]] for this session.
+
  
: Return undef if there isn't one.
+
@values = $repository-&gt;param: returns an array of the names of all the CGI parameters in the current request.
  
* $user = $repository-&gt;user( $user_id );
+
<!-- Edit below this comment -->
: 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 )
 
  
* $user = $repository-&gt;user_by_username( $username );
+
<!-- Pod2Wiki= -->
: Return the user with the given username, or undef.
+
<!-- Pod2Wiki=head_xml -->
 +
===xml===
  
* $user = $repository-&gt;user_by_email( $email );
+
<source lang="perl">$xml = $repo->xml
: Return the [[API:EPrints/DataObj/User|EPrints::DataObj::User]] with the given email, or undef.
+
  
* $dataset = $repository-&gt;dataset( $setname )
+
</source>
: Return a given [[API:EPrints/DataSet|EPrints::DataSet]] or undef if it doesn't exist.
+
Return an [[API:EPrints/XML|EPrints::XML]] object for working with XML.
  
* $confitem = $repository-&gt;config( $key, [@subkeys] )
+
<!-- Edit below this comment -->
: Returns a named configuration setting including those defined in archvies/&lt;archive_id&gt;/cfg/cfg.d/
+
  
: $repository-&gt;config( "stuff", "en", "foo" )
 
  
: is equivalent to
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_xhtml -->
 +
===xhtml===
  
: $repository-&gt;config( "stuff" )-&gt;{en}-&gt;{foo}
+
<source lang="perl">$xhtml = $repo->xhtml
  
* $repository-&gt;log( $msg [, $level ] )
+
</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]].
+
Return an [[API:EPrints/XHTML|EPrints::XHTML]] object for working with XHTML.
  
: To override where log messages are sent define the <code>log</code> callback:
+
<!-- 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_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 )
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_user_by_username -->
 +
===user_by_username===
 +
 
 +
<source lang="perl">$user = $repository->user_by_username( $username );
 +
 
 +
</source>
 +
Return the user with the given username, or undef.
 +
 
 +
<!-- 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.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_dataset -->
 +
===dataset===
 +
 
 +
<source lang="perl">$dataset = $repository->dataset( $setname )
 +
 
 +
</source>
 +
Return a given [[API:EPrints/DataSet|EPrints::DataSet]] or undef if it doesn't exist.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_config -->
 +
===config===
 +
 
 +
<source lang="perl">$confitem = $repository->config( $key, [@subkeys] )
 +
 
 +
</source>
 +
Returns a named configuration setting including those defined in archvies/&lt;archive_id&gt;/cfg/cfg.d/
 +
 
 +
$repository-&gt;config( "stuff", "en", "foo" )
 +
 
 +
is equivalent to
 +
 
 +
$repository-&gt;config( "stuff" )-&gt;{en}-&gt;{foo}
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_log -->
 +
===log===
 +
 
 +
<source lang="perl">$repository->log( $msg [, $level ] )
 +
 
 +
</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 {
 
<pre>  $c-&gt;{log} = sub {
Line 124: Line 228:
 
   };</pre>
 
   };</pre>
  
* $result = $repository-&gt;call( $cmd, @params )
+
<!-- Edit below this comment -->
: Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.
+
  
* $boolean = $repository-&gt;can_call( @cmd_conf_path )
 
: Return true if the given subroutine exists in this repository's config package.
 
  
* $result = $repository-&gt;try_call( $cmd, @params )
+
<!-- Pod2Wiki= -->
: Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.
+
<!-- Pod2Wiki=head_call -->
 +
===call===
  
: If the subroutine does not exist then quietly returns undef.
+
<source lang="perl">$result = $repository->call( $cmd, @params )
  
: This is used to call deprecated callback subroutines.
+
</source>
 +
Calls the subroutine named $cmd from the configuration perl modules for this repository with the given params and returns the result.
  
* @dirs = $repository-&gt;template_dirs( $langid )
+
<!-- Edit below this comment -->
: Returns a list of directories from which template files may be sourced, where the first matching template encountered is used.
+
  
: The directories searched are:
+
 
 +
<!-- Pod2Wiki= -->
 +
<!-- 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.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- 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/
 
<pre>  archives/[archiveid]/cfg/lang/[langid]/templates/
Line 150: Line 290:
 
   lib/templates/</pre>
 
   lib/templates/</pre>
  
* $id = $repository-&gt;id  
+
<!-- Edit below this comment -->
: Returns the id string of this repository.
+
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_id -->
 +
===id===
 +
 
 +
<source lang="perl">$id = $repository->id  
 +
 
 +
</source>
 +
Returns the id string of this repository.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- 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.
 +
 
 +
<!-- 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_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= -->
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_dom_related_methods -->
 +
===DOM Related Methods===
 +
These methods help build XML. Usually, but not always XHTML.
 +
 
 +
<!-- Pod2Wiki=end -->
 +
InternalDoc<!-- Edit below this comment -->
 +
 
  
* $returncode = $repository-&gt;exec( $cmd_id, %map )
+
<!-- Pod2Wiki= -->
: 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.  
+
<!-- Pod2Wiki=head_xhtml_related_methods -->
 +
===XHTML Related Methods===
 +
These methods help build XHTML.
  
* ( $returncode, $output) = $repository-&gt;test_config
+
<!-- Pod2Wiki=end -->
: 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.
+
InternalDoc<!-- Edit below this comment -->
  
: $returncode will be zero if everything seems OK.
 
  
: If not, then $output will contain the output of epadmin test
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_methods_relating_to_the_current_xhtml_page -->
 +
===Methods relating to the current XHTML page===
 +
<!-- Pod2Wiki=end -->
 +
InternalDoc<!-- Edit below this comment -->
  
* $ok = $repository-&gt;reload_config
 
: Trigger a configuration reload on the next request/index.
 
  
: To reload the configuration right now just call [[API:EPrints/Repository#load_config|load_config]].
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_methods_related_to_plugins -->
 +
===Methods related to Plugins===
 +
<!-- Pod2Wiki=end -->
 +
InternalDoc<!-- Edit below this comment -->
  
* $noise_level = $repository-&gt;noise
 
: Return the noise level for the current session. See the explaination under EPrints::Repository-&gt;new()
 
  
* $repo-&gt;init_from_indexer( $daemon )
+
<!-- Pod2Wiki= -->
: (Re)initialise the repository object for use by the indexer.
+
$repo-&gt;init_from_indexer( $daemon )
 +
(Re)initialise the repository object for use by the indexer.
  
: Calls [[API:EPrints/Repository#check_last_changed|check_last_changed]].
+
Calls [[API:EPrints/Repository#check_last_changed|check_last_changed]].
  
 
<!-- Pod2Wiki=head_copyright -->
 
<!-- Pod2Wiki=head_copyright -->
 
==COPYRIGHT==
 
==COPYRIGHT==
: Copyright 2000-2011 University of Southampton.
+
Copyright 2000-2011 University of Southampton.
  
: This file is part of EPrints http://www.eprints.org/.
+
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 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.
+
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/.
+
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 -->
 
<!-- Edit below this comment -->

Revision as of 08:38, 20 April 2012

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 - Single connection to a specific EPrints Repository


DESCRIPTION

This module is really a Repository, REALLY. The name is up to date and everything :-)

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 also provides access to the EPrints::XHTML class which contains many 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


query

$query = $repository->query

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


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.

$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_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.


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/


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.


noise

$noise_level = $repository->noise

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



DOM Related Methods

These methods help build XML. Usually, but not always XHTML.

InternalDoc


XHTML Related Methods

These methods help build XHTML.

InternalDoc


Methods relating to the current XHTML page

InternalDoc


Methods related to Plugins

InternalDoc


$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/.