Difference between revisions of "API:EPrints/DataObj/EPrint"

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/DataObj/EPrint.pm|package_name=EPrints::DataObj::EPrint}}[[Category:API|EPrint]]<div><!-- Edit below this comment -->
−
__NOTOC__
 
−
{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/EPrint.pm|package_name=EPrints::DataObj::EPrint}}[[Category:API|EPrint]]<div><!-- Edit below this comment -->
 
  
  
−
<!-- Pod2Wiki=head_name --></div>
+
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
 
'''EPrints::DataObj::EPrint''' - Class representing an actual EPrint
 
'''EPrints::DataObj::EPrint''' - Class representing an actual EPrint
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=head_description --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
 
This class represents a single eprint record and the metadata  associated with it. This is associated with one of more  EPrint::Document objects.
 
This class represents a single eprint record and the metadata  associated with it. This is associated with one of more  EPrint::Document objects.
Line 22: Line 22:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=head_system_metadata --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_system_metadata -->
 
==SYSTEM METADATA==
 
==SYSTEM METADATA==
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_eprintid --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_eprintid -->
 
===eprintid (int)===
 
===eprintid (int)===
  
Line 39: Line 43:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_rev_number --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_rev_number -->
 
===rev_number (int)===
 
===rev_number (int)===
  
Line 49: Line 55:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_userid --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_userid -->
 
===userid (itemref)===
 
===userid (itemref)===
  
Line 59: Line 67:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_dir --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_dir -->
 
===dir (text)===
 
===dir (text)===
  
Line 69: Line 79:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_datestamp --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_datestamp -->
 
===datestamp (time)===
 
===datestamp (time)===
  
Line 79: Line 91:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_lastmod --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_lastmod -->
 
===lastmod (time)===
 
===lastmod (time)===
  
Line 89: Line 103:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_status_changes --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_status_changes -->
 
===status_changes (time)===
 
===status_changes (time)===
  
Line 99: Line 115:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_type --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_type -->
 
===type (namedset)===
 
===type (namedset)===
  
Line 109: Line 127:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_succeeds --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_succeeds -->
 
===succeeds (itemref)===
 
===succeeds (itemref)===
  
Line 119: Line 139:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_commentary --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_commentary -->
 
===commentary (itemref)===
 
===commentary (itemref)===
  
Line 129: Line 151:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_replacedby --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_replacedby -->
 
===replacedby (itemref)===
 
===replacedby (itemref)===
  
Line 139: Line 163:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=head_methods --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_methods -->
 
==METHODS==
 
==METHODS==
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_system_field_info --></div>
+
<!-- Pod2Wiki= -->
−
===$metadata = EPrints::DataObj::EPrint-&gt;get_system_field_info===
+
</div>
 +
<!-- Pod2Wiki=item_get_system_field_info -->
 +
===get_system_field_info===
  
 +
$metadata = EPrints::DataObj::EPrint-&gt;get_system_field_info
 
Return an array describing the system metadata of the EPrint dataset.
 
Return an array describing the system metadata of the EPrint dataset.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_set_item_issues --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;set_item_issues( $new_issues )===
+
</div>
 +
<!-- Pod2Wiki=item_set_item_issues -->
 +
===set_item_issues===
  
 +
$eprint-&gt;set_item_issues( $new_issues )
 
This method updates the issues attached to this eprint based on the new issues passed.
 
This method updates the issues attached to this eprint based on the new issues passed.
  
Line 170: Line 202:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_dataset_id --></div>
+
<!-- Pod2Wiki= -->
−
===$dataset = EPrints::DataObj::EPrint-&gt;get_dataset_id===
+
</div>
 +
<!-- Pod2Wiki=item_fileinfo -->
 +
===fileinfo===
  
 +
$eprint-&gt;fileinfo()
 +
The special '''fileinfo''' field contains the icon URL and main-file URL for each non-volatile document in the eprint. This is a performance tweak to avoid having to retrieve documents when rendering eprint citations.
 +
 +
Example:
 +
 +
  /style/images/fileicons/application_pdf.png;/20/1/paper.pdf|/20/4.hassmallThumbnailVersion/tdb_portrait.jpg;/20/4/tdb_portrait.jpg
 +
 
 +
These URLs are relative to the current repository base path ('http_url').
 +
 +
<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_get_dataset_id -->
 +
===get_dataset_id===
 +
 +
$dataset = EPrints::DataObj::EPrint-&gt;get_dataset_id
 
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
 
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_dataset --></div>
+
<!-- Pod2Wiki= -->
−
===$dataset = $eprint-&gt;get_dataset===
+
</div>
 +
<!-- Pod2Wiki=item_get_dataset -->
 +
===get_dataset===
  
 +
$dataset = $eprint-&gt;get_dataset
 
Return the dataset to which this object belongs. This will return one of the virtual datasets: inbox, buffer, archive or deletion.
 
Return the dataset to which this object belongs. This will return one of the virtual datasets: inbox, buffer, archive or deletion.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_defaults --></div>
+
<!-- Pod2Wiki= -->
−
===$defaults = EPrints::DataObj::EPrint-&gt;get_defaults( $session, $data )===
+
</div>
 +
<!-- Pod2Wiki=item_get_defaults -->
 +
===get_defaults===
  
 +
$defaults = EPrints::DataObj::EPrint-&gt;get_defaults( $session, $data )
 
Return default values for this object based on the starting data.
 
Return default values for this object based on the starting data.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_clone --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint = $eprint-&gt;clone( $dest_dataset, $copy_documents, $link )===
+
</div>
 +
<!-- Pod2Wiki=item_clone -->
 +
===clone===
  
 +
$eprint = $eprint-&gt;clone( $dest_dataset, $copy_documents, $link )
 
Create a copy of this EPrint with a new ID in the given dataset. Return the new eprint, or undef in the case of an error.
 
Create a copy of this EPrint with a new ID in the given dataset. Return the new eprint, or undef in the case of an error.
  
Line 214: Line 277:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_log_mail_owner --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;log_mail_owner( $mail )===
+
</div>
 +
<!-- Pod2Wiki=item_log_mail_owner -->
 +
===log_mail_owner===
  
 +
$eprint-&gt;log_mail_owner( $mail )
 
Log that the given mail message was send to the owner of this EPrint.
 
Log that the given mail message was send to the owner of this EPrint.
  
Line 226: Line 292:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_editorial_contact --></div>
+
<!-- Pod2Wiki= -->
−
===$user = $eprint-&gt;get_editorial_contact===
+
</div>
 +
<!-- Pod2Wiki=item_get_editorial_contact -->
 +
===get_editorial_contact===
  
 +
$user = $eprint-&gt;get_editorial_contact
 
Return the user identified as the editorial contact for this item.
 
Return the user identified as the editorial contact for this item.
  
Line 240: Line 309:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_remove --></div>
+
<!-- Pod2Wiki= -->
−
===$success = $eprint-&gt;remove===
+
</div>
 +
<!-- Pod2Wiki=item_remove -->
 +
===remove===
  
 +
$success = $eprint-&gt;remove
 
Erase this eprint and any associated records from the database and filesystem.
 
Erase this eprint and any associated records from the database and filesystem.
  
Line 252: Line 324:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_commit --></div>
+
<!-- Pod2Wiki= -->
−
===$success = $eprint-&gt;commit( [$force] );===
+
</div>
 +
<!-- Pod2Wiki=item_commit -->
 +
===commit===
  
 +
$success = $eprint-&gt;commit( [$force] );
 
Commit any changes that might have been made to the database.
 
Commit any changes that might have been made to the database.
  
Line 266: Line 341:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_write_revision --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;write_revision===
+
</div>
 +
<!-- Pod2Wiki=item_write_revision -->
 +
===write_revision===
  
 +
$eprint-&gt;write_revision
 
Write out a snapshot of the XML describing the current state of the eprint.
 
Write out a snapshot of the XML describing the current state of the eprint.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_validate --></div>
+
<!-- Pod2Wiki= -->
−
===$problems = $eprint-&gt;validate( [$for_archive], $workflow_id )===
+
</div>
 +
<!-- Pod2Wiki=item_validate -->
 +
===validate===
  
 +
$problems = $eprint-&gt;validate( [$for_archive], $workflow_id )
 
Return a reference to an array of XHTML DOM objects describing validation problems with the entire eprint based on $workflow_id.
 
Return a reference to an array of XHTML DOM objects describing validation problems with the entire eprint based on $workflow_id.
  
Line 292: Line 373:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_skip_validation --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;skip_validation===
+
</div>
 +
<!-- Pod2Wiki=item_skip_validation -->
 +
===skip_validation===
  
 +
$boolean = $eprint-&gt;skip_validation
 
Returns true if this eprint should pass validation without being properly validated. This is to allow the use of dodgey data imported from legacy systems.
 
Returns true if this eprint should pass validation without being properly validated. This is to allow the use of dodgey data imported from legacy systems.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_prune_documents --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;prune_documents===
+
</div>
 +
<!-- Pod2Wiki=item_prune_documents -->
 +
===prune_documents===
  
 +
$eprint-&gt;prune_documents
 
Remove any documents associated with this eprint which don't actually have any files.
 
Remove any documents associated with this eprint which don't actually have any files.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_all_documents --></div>
+
<!-- Pod2Wiki= -->
−
===@documents = $eprint-&gt;get_all_documents===
+
</div>
 +
<!-- Pod2Wiki=item_get_all_documents -->
 +
===get_all_documents===
  
 +
@documents = $eprint-&gt;get_all_documents
 
Return an array of all EPrint::Document objects associated with this eprint.
 
Return an array of all EPrint::Document objects associated with this eprint.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_required_formats --></div>
+
<!-- Pod2Wiki= -->
−
===@formats = $eprint-&gt;required_formats===
+
</div>
 +
<!-- Pod2Wiki=item_required_formats -->
 +
===required_formats===
  
 +
@formats =  $eprint-&gt;required_formats
 
Return a list of the required formats for this  eprint. Only one of the required formats is required, not all.
 
Return a list of the required formats for this  eprint. Only one of the required formats is required, not all.
  
Line 334: Line 427:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_move_to_deletion --></div>
+
<!-- Pod2Wiki= -->
−
===$success = $eprint-&gt;move_to_deletion===
+
</div>
 +
<!-- Pod2Wiki=item_move_to_deletion -->
 +
===move_to_deletion===
  
 +
$success = $eprint-&gt;move_to_deletion
 
Transfer the EPrint into the "deletion" dataset. Should only be called in eprints in the "archive" dataset.
 
Transfer the EPrint into the "deletion" dataset. Should only be called in eprints in the "archive" dataset.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_move_to_inbox --></div>
+
<!-- Pod2Wiki= -->
−
===$success = $eprint-&gt;move_to_inbox===
+
</div>
 +
<!-- Pod2Wiki=item_move_to_inbox -->
 +
===move_to_inbox===
  
 +
$success = $eprint-&gt;move_to_inbox
 
Transfer the EPrint into the "inbox" dataset. Should only be called in eprints in the "buffer" dataset.
 
Transfer the EPrint into the "inbox" dataset. Should only be called in eprints in the "buffer" dataset.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_move_to_buffer --></div>
+
<!-- Pod2Wiki= -->
−
===$success = $eprint-&gt;move_to_buffer===
+
</div>
 +
<!-- Pod2Wiki=item_move_to_buffer -->
 +
===move_to_buffer===
  
 +
$success = $eprint-&gt;move_to_buffer
 
Transfer the EPrint into the "buffer" dataset. Should only be called in eprints in the "inbox" or "archive" dataset.
 
Transfer the EPrint into the "buffer" dataset. Should only be called in eprints in the "inbox" or "archive" dataset.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_move_to_archive --></div>
+
<!-- Pod2Wiki= -->
−
===$success = $eprint-&gt;move_to_archive===
+
</div>
 +
<!-- Pod2Wiki=item_move_to_archive -->
 +
===move_to_archive===
  
 +
$success = $eprint-&gt;move_to_archive
 
Move this eprint into the main "archive" dataset. Normally only called on eprints in "deletion" or "buffer" datasets.
 
Move this eprint into the main "archive" dataset. Normally only called on eprints in "deletion" or "buffer" datasets.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_local_path --></div>
+
<!-- Pod2Wiki= -->
−
===$path = $eprint-&gt;local_path===
+
</div>
 +
<!-- Pod2Wiki=item_local_path -->
 +
===local_path===
  
 +
$path = $eprint-&gt;local_path
 
Return the full path of the EPrint directory on the local filesystem. No trailing slash.
 
Return the full path of the EPrint directory on the local filesystem. No trailing slash.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_url_stem --></div>
+
<!-- Pod2Wiki= -->
−
===$url = $eprint-&gt;url_stem===
+
</div>
 +
<!-- Pod2Wiki=item_url_stem -->
 +
===url_stem===
  
 +
$url = $eprint-&gt;url_stem
 
Return the URL to this EPrint's directory. Note, this INCLUDES the trailing slash, unlike the local_path method.
 
Return the URL to this EPrint's directory. Note, this INCLUDES the trailing slash, unlike the local_path method.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_generate_static --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;generate_static===
+
</div>
 +
<!-- Pod2Wiki=item_generate_static -->
 +
===generate_static===
  
 +
$eprint-&gt;generate_static
 
Generate the static version of the abstract web page. In a multi-language repository this will generate one version per language.
 
Generate the static version of the abstract web page. In a multi-language repository this will generate one version per language.
  
Line 406: Line 520:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_generate_static_all_related --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;generate_static_all_related===
+
</div>
 +
<!-- Pod2Wiki=item_generate_static_all_related -->
 +
===generate_static_all_related===
  
 +
$eprint-&gt;generate_static_all_related
 
Generate the static pages for this eprint plus any it's related to, by succession or commentary.
 
Generate the static pages for this eprint plus any it's related to, by succession or commentary.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_remove_static --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;remove_static===
+
</div>
 +
<!-- Pod2Wiki=item_remove_static -->
 +
===remove_static===
  
 +
$eprint-&gt;remove_static
 
Remove the static web page or pages.
 
Remove the static web page or pages.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_render --></div>
+
<!-- Pod2Wiki= -->
−
===( $description, $title, $links ) = $eprint-&gt;render===
+
</div>
 +
<!-- Pod2Wiki=item_render -->
 +
===render===
  
 +
( $description, $title, $links ) = $eprint-&gt;render
 
Render the eprint. The 3 returned values are references to XHTML DOM objects. $description is the public viewable description of this eprint that appears as the body of the abstract page. $title is the title of the abstract page for this eprint. $links is any elements which should go in the &lt;head&gt; of this page.
 
Render the eprint. The 3 returned values are references to XHTML DOM objects. $description is the public viewable description of this eprint that appears as the body of the abstract page. $title is the title of the abstract page for this eprint. $links is any elements which should go in the &lt;head&gt; of this page.
  
Line 438: Line 561:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_render_history --></div>
+
<!-- Pod2Wiki= -->
−
===( $html ) = $eprint-&gt;render_history===
+
</div>
 +
<!-- Pod2Wiki=item_render_history -->
 +
===render_history===
  
 +
( $html ) = $eprint-&gt;render_history
 
Render the history of this eprint as XHTML DOM.
 
Render the history of this eprint as XHTML DOM.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_control_url --></div>
+
<!-- Pod2Wiki= -->
−
===$url = $eprint-&gt;get_control_url===
+
</div>
 +
<!-- Pod2Wiki=item_get_control_url -->
 +
===get_control_url===
  
 +
$url = $eprint-&gt;get_control_url
 
Return the URL of the control page for this eprint.
 
Return the URL of the control page for this eprint.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_url --></div>
+
<!-- Pod2Wiki= -->
−
===$url = $eprint-&gt;get_url===
+
</div>
 +
<!-- Pod2Wiki=item_get_url -->
 +
===get_url===
  
 +
$url = $eprint-&gt;get_url
 
Return the public URL of this eprints abstract page.  
 
Return the public URL of this eprints abstract page.  
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_user --></div>
+
<!-- Pod2Wiki= -->
−
===$user = $eprint-&gt;get_user===
+
</div>
 +
<!-- Pod2Wiki=item_get_user -->
 +
===get_user===
  
 +
$user = $eprint-&gt;get_user
 
Return the EPrints::User to whom this eprint belongs (if any).
 
Return the EPrints::User to whom this eprint belongs (if any).
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_all_related --></div>
+
<!-- Pod2Wiki= -->
−
===@eprints = $eprint-&gt;get_all_related===
+
</div>
 +
<!-- Pod2Wiki=item_get_all_related -->
 +
===get_all_related===
  
 +
@eprints = $eprint-&gt;get_all_related
 
Return the eprints that are related in some way to this in a succession or commentary thread. The returned list does NOT include this EPrint.
 
Return the eprints that are related in some way to this in a succession or commentary thread. The returned list does NOT include this EPrint.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_in_thread --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;in_thread( $field )===
+
</div>
 +
<!-- Pod2Wiki=item_in_thread -->
 +
===in_thread===
  
 +
$boolean = $eprint-&gt;in_thread( $field )
 
Return true if this eprint is part of a thread of $field. $field should be an EPrint::MetaField representing either "commentary" or "succeeds".
 
Return true if this eprint is part of a thread of $field. $field should be an EPrint::MetaField representing either "commentary" or "succeeds".
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_first_in_thread --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint = $eprint-&gt;first_in_thread( $field )===
+
</div>
 +
<!-- Pod2Wiki=item_first_in_thread -->
 +
===first_in_thread===
  
 +
$eprint = $eprint-&gt;first_in_thread( $field )
 
Return the first (earliest) version or first paper in the thread of commentaries of this paper in the repository.
 
Return the first (earliest) version or first paper in the thread of commentaries of this paper in the 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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_later_in_thread --></div>
+
<!-- Pod2Wiki= -->
−
===@eprints = $eprint-&gt;later_in_thread( $field )===
+
</div>
 +
<!-- Pod2Wiki=item_later_in_thread -->
 +
===later_in_thread===
  
 +
@eprints = $eprint-&gt;later_in_thread( $field )
 
Return a list of the immediately later items in the thread.  
 
Return a list of the immediately later items in the thread.  
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_all_in_thread --></div>
+
<!-- Pod2Wiki= -->
−
===@eprints = $eprint-&gt;all_in_thread( $field )===
+
</div>
 +
<!-- Pod2Wiki=item_all_in_thread -->
 +
===all_in_thread===
  
 +
@eprints = $eprint-&gt;all_in_thread( $field )
 
Return all of the EPrints in the given thread.
 
Return all of the EPrints in the given thread.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_last_in_thread --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint = $eprint-&gt;last_in_thread( $field )===
+
</div>
 +
<!-- Pod2Wiki=item_last_in_thread -->
 +
===last_in_thread===
  
 +
$eprint = $eprint-&gt;last_in_thread( $field )
 
Return the last item in the specified thread.
 
Return the last item in the specified thread.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_remove_from_threads --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;remove_from_threads===
+
</div>
 +
<!-- Pod2Wiki=item_remove_from_threads -->
 +
===remove_from_threads===
  
 +
$eprint-&gt;remove_from_threads
 
Extract the eprint from any threads it's in. i.e., if any other paper is a later version of or commentary on this paper, the link from that paper to this will be removed.
 
Extract the eprint from any threads it's in. i.e., if any other paper is a later version of or commentary on this paper, the link from that paper to this will be removed.
  
Line 550: Line 706:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_render_version_thread --></div>
+
<!-- Pod2Wiki= -->
−
===$xhtml = $eprint-&gt;render_version_thread( $field )===
+
</div>
 +
<!-- Pod2Wiki=item_render_version_thread -->
 +
===render_version_thread===
  
 +
$xhtml = $eprint-&gt;render_version_thread( $field )
 
Render XHTML DOM describing the entire thread as nested unordered lists.
 
Render XHTML DOM describing the entire thread as nested unordered lists.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_loop_error --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;loop_error( $field, @looped_ids )===
+
</div>
 +
<!-- Pod2Wiki=item_loop_error -->
 +
===loop_error===
  
 +
$eprint-&gt;loop_error( $field, @looped_ids )
 
This eprint is part of a threading loop which is not allowed. Log a warning.
 
This eprint is part of a threading loop which is not allowed. Log a warning.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_get_type --></div>
+
<!-- Pod2Wiki= -->
−
===$type = $eprint-&gt;get_type===
+
</div>
 +
<!-- Pod2Wiki=item_get_type -->
 +
===get_type===
  
 +
$type = $eprint-&gt;get_type
 
Return the type of this eprint.
 
Return the type of this eprint.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_render_export_links --></div>
+
<!-- Pod2Wiki= -->
−
===$xhtml_ul_list = $eprint-&gt;render_export_links( [$staff] )===
+
</div>
 +
<!-- Pod2Wiki=item_render_export_links -->
 +
===render_export_links===
  
 +
$xhtml_ul_list = $eprint-&gt;render_export_links( [$staff] )
 
Return a &lt;ul&gt; list containing links to all the formats this eprint is available in.  
 
Return a &lt;ul&gt; list containing links to all the formats this eprint is available in.  
  
Line 592: Line 760:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_user_roles --></div>
+
<!-- Pod2Wiki= -->
−
===@roles = $eprint-&gt;user_roles( $user )===
+
</div>
 +
<!-- Pod2Wiki=item_user_roles -->
 +
===user_roles===
  
 +
@roles = $eprint-&gt;user_roles( $user )
 
Return the @roles $user has on $eprint.
 
Return the @roles $user has on $eprint.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_datestamp --></div>
+
<!-- Pod2Wiki= -->
−
===$eprint-&gt;datestamp===
+
</div>
 +
<!-- Pod2Wiki=item_datestamp -->
 +
===datestamp===
  
 +
$eprint-&gt;datestamp
 
DEPRECATED.
 
DEPRECATED.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_in_editorial_scope_of --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;in_editorial_scope_of( $possible_editor )===
+
</div>
 +
<!-- Pod2Wiki=item_in_editorial_scope_of -->
 +
===in_editorial_scope_of===
  
 +
$boolean = $eprint-&gt;in_editorial_scope_of( $possible_editor )
 
Returns true if $possible_editor can edit this eprint. This is according to the user editperms.  
 
Returns true if $possible_editor can edit this eprint. This is according to the user editperms.  
  
Line 624: Line 801:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_has_owner --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;has_owner( $possible_owner )===
+
</div>
 +
<!-- Pod2Wiki=item_has_owner -->
 +
===has_owner===
  
 +
$boolean = $eprint-&gt;has_owner( $possible_owner )
 
Returns true if $possible_owner can edit this eprint. This is according to the user editperms.  
 
Returns true if $possible_owner can edit this eprint. This is according to the user editperms.  
  
Line 638: Line 818:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_obtain_lock --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;obtain_lock( $user )===
+
</div>
 +
<!-- Pod2Wiki=item_obtain_lock -->
 +
===obtain_lock===
  
 +
$boolean = $eprint-&gt;obtain_lock( $user )
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_could_obtain_lock --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;could_obtain_lock( $user )===
+
</div>
 +
<!-- Pod2Wiki=item_could_obtain_lock -->
 +
===could_obtain_lock===
  
 +
$boolean = $eprint-&gt;could_obtain_lock( $user )
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_is_locked --></div>
+
<!-- Pod2Wiki= -->
−
===$boolean = $eprint-&gt;is_locked()===
+
</div>
 +
<!-- Pod2Wiki=item_is_locked -->
 +
===is_locked===
  
 +
$boolean = $eprint-&gt;is_locked()
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_render_edit_lock --></div>
+
<!-- Pod2Wiki= -->
−
===$xhtml = render_edit_lock( $session, $value )===
+
</div>
 +
<!-- Pod2Wiki=item_render_edit_lock -->
 +
===render_edit_lock===
  
 +
$xhtml = render_edit_lock( $session, $value )
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=head_callbacks --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_callbacks -->
 
==CALLBACKS==
 
==CALLBACKS==
 
Callbacks may optionally be defined in the ArchiveConfig.
 
Callbacks may optionally be defined in the ArchiveConfig.
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_validate_field --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_validate_field -->
 
===validate_field===
 
===validate_field===
  
Line 689: Line 885:
 
    
 
    
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_validate_eprint --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_validate_eprint -->
 
===validate_eprint===
 
===validate_eprint===
  
Line 699: Line 897:
 
    
 
    
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_set_eprint_defaults --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_set_eprint_defaults -->
 
===set_eprint_defaults===
 
===set_eprint_defaults===
  
Line 709: Line 909:
 
    
 
    
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_set_eprint_automatic_fields --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_set_eprint_automatic_fields -->
 
===set_eprint_automatic_fields===
 
===set_eprint_automatic_fields===
  
Line 719: Line 921:
 
    
 
    
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
−
<!-- Pod2Wiki=item_eprint_render --></div>
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_eprint_render -->
 
===eprint_render===
 
===eprint_render===
  
Line 731: Line 935:
  
 
<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%; '>
−
<h4><span style='display:none'>User Comments</span></h4>
+
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 +
<!-- Pod2Wiki= -->
 +
</div>
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

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

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataObj::EPrint - Class representing an actual EPrint

User Comments


DESCRIPTION

This class represents a single eprint record and the metadata associated with it. This is associated with one of more EPrint::Document objects.

EPrints::DataObj::EPrint is a subclass of EPrints::DataObj with the following metadata fields (plus those defined in ArchiveMetadataFieldsConfig):

User Comments


SYSTEM METADATA

User Comments


eprintid (int)

The unique numerical ID of this eprint.

User Comments


rev_number (int)

The number of the current revision of this record.

User Comments


userid (itemref)

The id of the user who deposited this eprint (if any). Scripted importing could cause this not to be set.

User Comments


dir (text)

The directory, relative to the documents directory for this repository, which this eprints data is stored in. Eg. disk0/00/00/03/34 for record 334.

User Comments


datestamp (time)

The date this record first appeared live in the repository.

User Comments


lastmod (time)

The date this record was last modified.

User Comments


status_changes (time)

The date/time this record was moved between inbox, buffer, archive, etc.

User Comments


type (namedset)

The type of this record, one of the types of the "eprint" dataset.

User Comments


succeeds (itemref)

The ID of the eprint (if any) which this succeeds. This field should have been an int and may be changed in a later upgrade.

User Comments


commentary (itemref)

The ID of the eprint (if any) which this eprint is a commentary on. This field should have been an int and may be changed in a later upgrade.

User Comments


replacedby (itemref)

The ID of the eprint (if any) which has replaced this eprint. This is only set on records in the "deletion" dataset. This field should have been an int and may be changed in a later upgrade.

User Comments


METHODS

User Comments


get_system_field_info

$metadata = EPrints::DataObj::EPrint->get_system_field_info

Return an array describing the system metadata of the EPrint dataset.

User Comments


set_item_issues

$eprint->set_item_issues( $new_issues )

This method updates the issues attached to this eprint based on the new issues passed.

If an existing issue is set as "discovered" and doesn't exist in $new_issues its status will be updated to "autoresolved", otherwise the old issue's status and description are updated.

Any issues in $new_issues that don't already exist will be appended.

User Comments


fileinfo

$eprint->fileinfo()

The special fileinfo field contains the icon URL and main-file URL for each non-volatile document in the eprint. This is a performance tweak to avoid having to retrieve documents when rendering eprint citations.

Example: 

 /style/images/fileicons/application_pdf.png;/20/1/paper.pdf|/20/4.hassmallThumbnailVersion/tdb_portrait.jpg;/20/4/tdb_portrait.jpg

These URLs are relative to the current repository base path ('http_url').

User Comments


get_dataset_id

$dataset = EPrints::DataObj::EPrint->get_dataset_id

Returns the id of the EPrints::DataSet object to which this record belongs.

User Comments


get_dataset

$dataset = $eprint->get_dataset

Return the dataset to which this object belongs. This will return one of the virtual datasets: inbox, buffer, archive or deletion.

User Comments


get_defaults

$defaults = EPrints::DataObj::EPrint->get_defaults( $session, $data )

Return default values for this object based on the starting data.

User Comments


clone

$eprint = $eprint->clone( $dest_dataset, $copy_documents, $link )

Create a copy of this EPrint with a new ID in the given dataset. Return the new eprint, or undef in the case of an error.

If $copy_documents is set and true then the documents (and files) will be copied in addition to the metadata.

If $nolink is true then the new eprint is not connected to the old one.

User Comments


log_mail_owner

$eprint->log_mail_owner( $mail )

Log that the given mail message was send to the owner of this EPrint.

$mail is the same XHTML DOM that was sent as the email.

User Comments


get_editorial_contact

$user = $eprint->get_editorial_contact

Return the user identified as the editorial contact for this item.

By default returns undef.

nb. This has nothing to do with the editor defined in the metadata

User Comments


remove

$success = $eprint->remove

Erase this eprint and any associated records from the database and filesystem.

This should only be called on eprints in "inbox" or "buffer".

User Comments


commit

$success = $eprint->commit( [$force] );

Commit any changes that might have been made to the database.

If the item has not be changed then this function does nothing unless $force is true.

Calls /set_eprint_automatic_fields just before the $eprint is committed.

User Comments


write_revision

$eprint->write_revision

Write out a snapshot of the XML describing the current state of the eprint.

User Comments


validate

$problems = $eprint->validate( [$for_archive], $workflow_id )

Return a reference to an array of XHTML DOM objects describing validation problems with the entire eprint based on $workflow_id.

If $workflow_id is undefined defaults to "default".

A reference to an empty array indicates no problems.

Calls /validate_eprint for the $eprint.

User Comments


skip_validation

$boolean = $eprint->skip_validation

Returns true if this eprint should pass validation without being properly validated. This is to allow the use of dodgey data imported from legacy systems.

User Comments


prune_documents

$eprint->prune_documents

Remove any documents associated with this eprint which don't actually have any files.

User Comments


get_all_documents

@documents = $eprint->get_all_documents

Return an array of all EPrint::Document objects associated with this eprint.

User Comments


required_formats

@formats =  $eprint->required_formats

Return a list of the required formats for this eprint. Only one of the required formats is required, not all.

An empty list means no format is required.

User Comments


move_to_deletion

$success = $eprint->move_to_deletion

Transfer the EPrint into the "deletion" dataset. Should only be called in eprints in the "archive" dataset.

User Comments


move_to_inbox

$success = $eprint->move_to_inbox

Transfer the EPrint into the "inbox" dataset. Should only be called in eprints in the "buffer" dataset.

User Comments


move_to_buffer

$success = $eprint->move_to_buffer

Transfer the EPrint into the "buffer" dataset. Should only be called in eprints in the "inbox" or "archive" dataset.

User Comments


move_to_archive

$success = $eprint->move_to_archive

Move this eprint into the main "archive" dataset. Normally only called on eprints in "deletion" or "buffer" datasets.

User Comments


local_path

$path = $eprint->local_path

Return the full path of the EPrint directory on the local filesystem. No trailing slash.

User Comments


url_stem

$url = $eprint->url_stem

Return the URL to this EPrint's directory. Note, this INCLUDES the trailing slash, unlike the local_path method.

User Comments


generate_static

$eprint->generate_static

Generate the static version of the abstract web page. In a multi-language repository this will generate one version per language.

If called on inbox or buffer, remove the abstract page.

User Comments


generate_static_all_related

$eprint->generate_static_all_related

Generate the static pages for this eprint plus any it's related to, by succession or commentary.

User Comments


remove_static

$eprint->remove_static

Remove the static web page or pages.

User Comments


render

( $description, $title, $links ) = $eprint->render

Render the eprint. The 3 returned values are references to XHTML DOM objects. $description is the public viewable description of this eprint that appears as the body of the abstract page. $title is the title of the abstract page for this eprint. $links is any elements which should go in the <head> of this page.

Calls /eprint_render to actually render the $eprint, if it isn't deleted.

User Comments


render_history

( $html ) = $eprint->render_history

Render the history of this eprint as XHTML DOM.

User Comments


get_control_url

$url = $eprint->get_control_url

Return the URL of the control page for this eprint.

User Comments


get_url

$url = $eprint->get_url

Return the public URL of this eprints abstract page.

User Comments


get_user

$user = $eprint->get_user

Return the EPrints::User to whom this eprint belongs (if any).

User Comments


get_all_related

@eprints = $eprint->get_all_related

Return the eprints that are related in some way to this in a succession or commentary thread. The returned list does NOT include this EPrint.

User Comments


in_thread

$boolean = $eprint->in_thread( $field )

Return true if this eprint is part of a thread of $field. $field should be an EPrint::MetaField representing either "commentary" or "succeeds".

User Comments


first_in_thread

$eprint = $eprint->first_in_thread( $field )

Return the first (earliest) version or first paper in the thread of commentaries of this paper in the repository.

User Comments


later_in_thread

@eprints = $eprint->later_in_thread( $field )

Return a list of the immediately later items in the thread.

User Comments


all_in_thread

@eprints = $eprint->all_in_thread( $field )

Return all of the EPrints in the given thread.

User Comments


last_in_thread

$eprint = $eprint->last_in_thread( $field )

Return the last item in the specified thread.

User Comments


remove_from_threads

$eprint->remove_from_threads

Extract the eprint from any threads it's in. i.e., if any other paper is a later version of or commentary on this paper, the link from that paper to this will be removed.

Abstract pages are updated if needed.

User Comments


render_version_thread

$xhtml = $eprint->render_version_thread( $field )

Render XHTML DOM describing the entire thread as nested unordered lists.

User Comments


loop_error

$eprint->loop_error( $field, @looped_ids )

This eprint is part of a threading loop which is not allowed. Log a warning.

User Comments


get_type

$type = $eprint->get_type

Return the type of this eprint.

User Comments


render_export_links

$xhtml_ul_list = $eprint->render_export_links( [$staff] )

Return a <ul> list containing links to all the formats this eprint is available in.

If $staff is true then show all formats available to staff, and link to the staff export URL.

User Comments


user_roles

@roles = $eprint->user_roles( $user )

Return the @roles $user has on $eprint.

User Comments


datestamp

$eprint->datestamp

DEPRECATED.

User Comments


in_editorial_scope_of

$boolean = $eprint->in_editorial_scope_of( $possible_editor )

Returns true if $possible_editor can edit this eprint. This is according to the user editperms.

This does not mean the user has the editor priv., just that if they do then they may edit the given item.

User Comments


has_owner

$boolean = $eprint->has_owner( $possible_owner )

Returns true if $possible_owner can edit this eprint. This is according to the user editperms.

This does not mean the user has the editor priv., just that if they do then they may edit the given item.

Uses the callback "does_user_own_eprint" if available.

User Comments


obtain_lock

$boolean = $eprint->obtain_lock( $user )

User Comments


could_obtain_lock

$boolean = $eprint->could_obtain_lock( $user )

User Comments


is_locked

$boolean = $eprint->is_locked()

User Comments


render_edit_lock

$xhtml = render_edit_lock( $session, $value )

User Comments


CALLBACKS

Callbacks may optionally be defined in the ArchiveConfig.

User Comments


validate_field

 validate_field( $field, $value, $session, [$for_archive] )

User Comments


validate_eprint

 validate_eprint( $eprint, $session, [$for_archive] )

User Comments


set_eprint_defaults

 set_eprint_defaults( $data, $session )

User Comments


set_eprint_automatic_fields

 set_eprint_automatic_fields( $eprint )

User Comments


eprint_render

 eprint_render( $eprint, $session )

See ArchiveRenderConfig/eprint_render.

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/DataObj/EPrint&oldid=8738’