Difference between revisions of "API:EPrints/RepositoryConfig"

From EPrints Documentation
Jump to: navigation, search
(Created page with '<!-- 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' com…')
 
Line 8: Line 8:
 
'''EPrints::RepositoryConfig''' - Repository Configuration
 
'''EPrints::RepositoryConfig''' - Repository Configuration
  
 +
<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_synopsis -->
 +
==SYNOPSIS==
 +
  $c-&gt;add_dataset_field( "eprint", {
 +
    name =&gt; "title",
 +
    type =&gt; "longtext",
 +
  }, reuse =&gt; 1 );
 +
 
 
<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%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 52: Line 66:
 
See [[API:EPrints/Const|EPrints::Const]] for available triggers.
 
See [[API:EPrints/Const|EPrints::Const]] for available triggers.
  
See {{API:PodLink|file=|package_name=|section=add_trigger|text=/add_trigger}} for %opts.
+
See [[API:EPrints/RepositoryConfig#add_trigger|add_trigger]] for %opts.
  
 
<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 73: Line 87:
 
   priority - used to determine the order triggers are executed in (defaults to 0).
 
   priority - used to determine the order triggers are executed in (defaults to 0).
 
    
 
    
 +
<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=item_add_dataset_field -->
 +
====add_dataset_field====
 +
 +
$c-&gt;add_dataset_field( $datasetid, $fielddata, %opts )
 +
Add a field spec $fielddata to dataset $datasetid.
 +
 +
This method will abort if the field already exists and 'reuse' is unspecified.
 +
 +
Options:
 +
reuse - re-use an existing field if it exists (must be same type)
 +
 +
<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_copyright -->
 +
==COPYRIGHT==
 
<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%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>

Revision as of 10:46, 25 August 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::RepositoryConfig - Repository Configuration

User Comments


SYNOPSIS

 $c->add_dataset_field( "eprint", {
   name => "title",
   type => "longtext",
 }, reuse => 1 );
 

User Comments


DESCRIPTION

This provides methods for reading and setting a repository configuration. Setter methods may only be used in the configuration.

User Comments


METHODS

User Comments


Setter Methods

User Comments


add_dataset_trigger

$c->add_dataset_trigger( $datasetid, TRIGGER_ID, $f, %opts )

Register a function reference $f to be called when the TRIGGER_ID event happens on $datasetid.

See EPrints::Const for available triggers.

See add_trigger for %opts.

User Comments


add_trigger

$c->add_trigger( TRIGGER_ID, $f, %opts )

Register a function reference $f to be called when the TRIGGER_ID event happens.

See EPrints::Const for available triggers.

Options:

 priority - used to determine the order triggers are executed in (defaults to 0).
 

User Comments


add_dataset_field

$c->add_dataset_field( $datasetid, $fielddata, %opts )

Add a field spec $fielddata to dataset $datasetid.

This method will abort if the field already exists and 'reuse' is unspecified.

Options: reuse - re-use an existing field if it exists (must be same type)

User Comments


COPYRIGHT

User Comments