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

From EPrints Documentation
Jump to: navigation, search
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/DataObj/EPrint.pm|package_name=EPrints::DataObj::EPrint}}[[Category:API|EPRINT]][[Category:API:EPrints/DataObj|EPRINT]][[Category:API:EPrints/DataObj/EPrint|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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_description --></div>
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
This class represents a single eprint record and the metadata  associated with it. This is associated with zero, one or many 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.
  
EPrints::DataObj::EPrint is a subclass of EPrints::DataObj with the following metadata fields (plus those defined in cfg.d/eprint_fields.pl):
+
EPrints::DataObj::EPrint is a subclass of EPrints::DataObj with the following metadata fields (plus those defined in ArchiveMetadataFieldsConfig):
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_synopsis --></div>
+
<!-- Pod2Wiki= -->
==SYNOPSIS==
+
<!-- Pod2Wiki=head_system_metadata -->
Inherrits all methods from [[API:EPrints/DataObj|EPrints::DataObj]].
+
==SYSTEM METADATA==
 +
* eprintid (int)
 +
: The unique numerical ID of this eprint.  
  
  # create a new eprint object (in the inbox):
+
* rev_number (int)
  my $inbox_ds = $handle-&gt;get_dataset( "inbox" );
+
: The number of the current revision of this record.
  my $epdata = { userid =&gt; $user-&gt;get_id, title =&gt; "Default title" };
+
 
  my $eprint = $inbox_ds-&gt;create_object( $handle, $epdata );
+
* userid (itemref)
 
+
: The id of the user who deposited this eprint (if any). Scripted importing could cause this not to be set.
  # open the eprint with id '$eprint_id'.
+
 
  $eprint = $handle-&gt;get_eprint( $eprint_id );
+
* 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.
  # open a public eprint with id '$eprint_id':
+
 
  $eprint = $handle-&gt;get_live_eprint( $eprint_id );
+
* datestamp (time)
 
+
: The date this record first appeared live in the repository.
  # set some metadata:
+
 
  $eprint-&gt;set_value( "title", "The title of this eprint" );
+
* lastmod (time)
 
+
: The date this record was last modified.
  # un-set some metadata:
+
 
  $eprint-&gt;set_value( "abstract", undef );
+
* status_changes (time)
 
+
: The date/time this record was moved between inbox, buffer, archive, etc.
  # retrieve some metatada:
+
 
  my $title = $eprint-&gt;get_value( "title" );
+
* type (namedset)
 
+
: The type of this record, one of the types of the "eprint" dataset.
  # commit values to the database:
+
 
  $eprint-&gt;commit;
+
* 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.
  # delete an eprint object *forever*:
+
 
  $eprint-&gt;remove;
+
* 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.
  # render all the documents of an eprint:
+
 
  foreach my $doc ( $eprint-&gt;get_all_documents )
+
* metadata_visibility (set)
  {
+
: This field is automatically set.
    $page-&gt;appendChild( $doc-&gt;render_citation );
+
 
  }
+
<pre>  show - appears normally
 
+
   no_search - hidden from search/views</pre>
  # move an eprint back to the owner's inbox:
+
 
  $eprint-&gt;move_to_inbox;
+
: The 'hide' option may be used to force an eprint to not appear in search/views but is not considered a stable option.
 
+
  # redirect to the eprint's abstract page:
+
  $handle-&gt;redirect( $eprint-&gt;get_url );
+
 
+
  # render some of the eprint's metadata
+
  $page-&gt;appendChild( $eprint-&gt;render_value( "title" ) );
+
    
+
  # render information about the owner of the eprint:
+
  my $xhtml = $eprint-&gt;get_user-&gt;render;
+
 
+
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_system_metadata --></div>
+
<!-- Pod2Wiki= -->
==SYSTEM METADATA==
+
<!-- Pod2Wiki=head_methods -->
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
==METHODS==
<h4><span style='display:none'>User Comments</span></h4>
+
<!-- Pod2Wiki=head_get_system_field_info -->
 +
===get_system_field_info===
 +
 
 +
<source lang="perl">$metadata = EPrints::DataObj::EPrint->get_system_field_info
 +
 
 +
</source>
 +
Return an array describing the system metadata of the EPrint dataset.
 +
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_eprintid --></div>
+
<!-- Pod2Wiki= -->
===eprintid (int)===
+
<!-- Pod2Wiki=head_fileinfo -->
 +
===fileinfo===
  
The unique numerical ID of this eprint.  
+
<source lang="perl">$eprint->fileinfo()
 +
 
 +
</source>
 +
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:
 +
 
 +
<pre>  /style/images/fileicons/application_pdf.png;/20/1/paper.pdf|/20/4.hassmallThumbnailVersion/tdb_portrait.jpg;/20/4/tdb_portrait.jpg</pre>
 +
 
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_rev_number --></div>
+
<!-- Pod2Wiki= -->
===rev_number (int)===
+
<!-- Pod2Wiki=head_get_dataset_id -->
 +
===get_dataset_id===
  
The number of the current revision of this record.
+
<source lang="perl">$dataset = EPrints::DataObj::EPrint->get_dataset_id
 +
 
 +
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_userid --></div>
+
<!-- Pod2Wiki= -->
===userid (itemref)===
+
<!-- Pod2Wiki=head_get_dataset -->
 +
===get_dataset===
 +
 
 +
<source lang="perl">$dataset = $eprint->get_dataset
  
The id of the user who deposited this eprint (if any). Scripted importing could cause this not to be set.
+
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_dir --></div>
+
<!-- Pod2Wiki= -->
===dir (text)===
+
<!-- Pod2Wiki=head_get_defaults -->
 +
===get_defaults===
  
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.
+
<source lang="perl">$defaults = EPrints::DataObj::EPrint->get_defaults( $session, $data )
 +
 
 +
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_datestamp --></div>
+
<!-- Pod2Wiki= -->
===datestamp (time)===
+
<!-- Pod2Wiki=head_clone -->
 +
===clone===
  
The date this record first appeared live in the repository.
+
<source lang="perl">$eprint = $eprint->clone( $dest_dataset, $copy_documents, $link )
 +
 
 +
</source>
 +
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.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_lastmod --></div>
+
<!-- Pod2Wiki= -->
===lastmod (time)===
+
<!-- Pod2Wiki=head_log_mail_owner -->
 +
===log_mail_owner===
 +
 
 +
<source lang="perl">$eprint->log_mail_owner( $mail )
 +
 
 +
</source>
 +
Log that the given mail message was send to the owner of this EPrint.
  
The date this record was last modified.
+
$mail is the same XHTML DOM that was sent as the email.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_status_changes --></div>
+
<!-- Pod2Wiki= -->
===status_changes (time)===
+
<!-- Pod2Wiki=head_get_editorial_contact -->
 +
===get_editorial_contact===
  
The date/time this record was moved between inbox, buffer, archive, etc.
+
<source lang="perl">$user = $eprint->get_editorial_contact
 +
 
 +
</source>
 +
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
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_type --></div>
+
<!-- Pod2Wiki= -->
===type (namedset)===
+
<!-- Pod2Wiki=head_remove -->
 +
===remove===
  
The type of this record, one of the types of the "eprint" dataset.
+
<source lang="perl">$success = $eprint->remove
 +
 
 +
</source>
 +
Erase this eprint and any associated records from the database and filesystem.
 +
 
 +
This should only be called on eprints in "inbox" or "buffer".
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_succeeds --></div>
+
<!-- Pod2Wiki= -->
===succeeds (itemref)===
+
<!-- Pod2Wiki=head_commit -->
 +
===commit===
  
The ID of the eprint (if any) which this succeedsThis field should have been an int and may be changed in a later upgrade.
+
<source lang="perl">$success = $eprint->commit( [$force] );
 +
 
 +
</source>
 +
Commit any changes to the database.
 +
 
 +
Calls [[API:EPrints/DataObj/EPrint#update_triggers|update_triggers]] just before the database is updated.
 +
 
 +
The actions this method does are dependent on some object attributes:
 +
 
 +
<pre>  changed - HASH of changed fields (from [[API:EPrints/DataObj|EPrints::DataObj]])
 +
  non_volatile_change - BOOL (from [[API:EPrints/DataObj|EPrints::DataObj]])
 +
  under_construction - BOOL</pre>
 +
 
 +
If '''datestamp''' is unset and this eprint is in the '''archive''' dataset datestamp will always be set which will in turn set '''datestamp''' as changed.
 +
 
 +
If no field values were changed and <code>$force</code> is false returns.
 +
 
 +
If <code>under_construction</code> is false:
 +
- static files updated
 +
 
 +
If <code>non_volatile_change</code> is true:
 +
  - '''lastmod''' field updated
 +
- triples update queued
 +
 
 +
If <code>under_construction</code> is false and <code>non_volatile_change</code> is true:
 +
- revision generated
 +
 
 +
The goal of these controls is to only trigger expensive processes in response to user actions. Revisions need to be generated when the user changes metadata or uploads new files (see [[API:EPrints/DataObj/Document#commit|EPrints::DataObj::Document/commit]]).
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_commentary --></div>
+
<!-- Pod2Wiki= -->
===commentary (itemref)===
+
<!-- Pod2Wiki=head_save_revision -->
 +
===save_revision===
 +
 
 +
<source lang="perl">$eprint->save_revision( %opts )
 +
 
 +
</source>
 +
Increase the eprint revision number and save a complete copy of the record into the history (see [[API:EPrints/DataObj/History|EPrints::DataObj::History]]).
 +
 
 +
Options:
  
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.
+
<pre>  user - user that caused the action to occur, defaults to current user
 +
  action - see history.action, defaults to "modify"
 +
  details - see history.details, defaults to a description of changed fields</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_replacedby --></div>
+
<!-- Pod2Wiki= -->
===replacedby (itemref)===
+
<!-- Pod2Wiki=head_validate -->
 +
===validate===
  
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.
+
<source lang="perl">$problems = $eprint->validate( [$for_archive], $workflow_id )
 +
 
 +
</source>
 +
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 [[API:EPrints/DataObj/EPrint#validate_eprint|validate_eprint]] for the <code>$eprint</code>.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_see_also --></div>
+
<!-- Pod2Wiki= -->
==SEE ALSO==
+
<!-- Pod2Wiki=head_skip_validation -->
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
===skip_validation===
<h4><span style='display:none'>User Comments</span></h4>
+
 
 +
<source lang="perl">$boolean = $eprint->skip_validation
 +
 
 +
</source>
 +
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.
 +
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_methods --></div>
+
<!-- Pod2Wiki= -->
==METHODS==
+
<!-- Pod2Wiki=head_prune_documents -->
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
===prune_documents===
<h4><span style='display:none'>User Comments</span></h4>
+
 
 +
<source lang="perl">$eprint->prune_documents
 +
 
 +
</source>
 +
Remove any documents associated with this eprint which don't actually have any files.
 +
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_all_documents --></div>
+
<!-- Pod2Wiki= -->
===@documents = $eprint-&gt;get_all_documents===
+
<!-- Pod2Wiki=head_get_all_documents -->
 +
===get_all_documents===
  
Return an array of all EPrint::Document objects associated with this eprint.
+
<source lang="perl">@documents = $eprint->get_all_documents
  
nb. This will not return associated documents such as thumbnails.
+
</source>
 +
Return a list of all {{API:PodLink|file=EPrint/Document|package_name=EPrint::Document|section=|text=EPrint::Document}} objects associated with this eprint excluding documents with a "isVolatileVersionOf" relation (e.g. thumbnails).
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_move_to_deletion --></div>
+
<!-- Pod2Wiki= -->
===$success = $eprint-&gt;move_to_deletion===
+
<!-- Pod2Wiki=head_move_to_deletion -->
 +
===move_to_deletion===
  
Transfer the EPrint into the "deletion" dataset. Should only be called for eprints in the "archive" dataset. This is called "retiring" in the Web interface.
+
<source lang="perl">$success = $eprint->move_to_deletion
  
nb. This does not delete the eprint.
+
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_move_to_inbox --></div>
+
<!-- Pod2Wiki= -->
===$success = $eprint-&gt;move_to_inbox===
+
<!-- Pod2Wiki=head_move_to_inbox -->
 +
===move_to_inbox===
  
Transfer the EPrint into the "inbox" dataset. Should only be called for eprints in the "buffer" dataset.
+
<source lang="perl">$success = $eprint->move_to_inbox
  
This means moving it back to the user workarea.
+
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_move_to_buffer --></div>
+
<!-- Pod2Wiki= -->
===$success = $eprint-&gt;move_to_buffer===
+
<!-- Pod2Wiki=head_move_to_buffer -->
 +
===move_to_buffer===
  
Transfer the EPrint into the "buffer" dataset. Should only be called for eprints in the "inbox" or "archive" dataset.
+
<source lang="perl">$success = $eprint->move_to_buffer
  
"buffer" is the internal code for the "review area".
+
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_move_to_archive --></div>
+
<!-- Pod2Wiki= -->
===$success = $eprint-&gt;move_to_archive===
+
<!-- Pod2Wiki=head_move_to_archive -->
 +
===move_to_archive===
  
Move this eprint into the main "archive" dataset. Normally only called for eprints in "deletion" or "buffer" datasets.
+
<source lang="perl">$success = $eprint->move_to_archive
  
This causes the item to appear on the website.
+
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_local_path --></div>
+
<!-- Pod2Wiki= -->
===$path = $eprint-&gt;local_path===
+
<!-- Pod2Wiki=head_local_path -->
 +
===local_path===
  
 +
<source lang="perl">$path = $eprint->local_path
 +
 +
</source>
 
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_url_stem --></div>
+
<!-- Pod2Wiki= -->
===$url = $eprint-&gt;url_stem===
+
<!-- Pod2Wiki=head_url_stem -->
 +
===url_stem===
 +
 
 +
<source lang="perl">$url = $eprint->url_stem
  
 +
</source>
 
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_generate_static --></div>
+
<!-- Pod2Wiki= -->
===$eprint-&gt;generate_static===
+
<!-- Pod2Wiki=head_generate_static -->
 +
===generate_static===
  
 +
<source lang="perl">$eprint->generate_static
 +
 +
</source>
 
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.
  
 
If called on inbox or buffer, remove the abstract page.
 
If called on inbox or buffer, remove the 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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_user --></div>
+
<!-- Pod2Wiki= -->
===$user = $eprint-&gt;get_user===
+
<!-- Pod2Wiki=head_remove_static -->
 +
===remove_static===
  
Return the EPrints::User to whom this eprint belongs (if any).
+
<source lang="perl">$eprint->remove_static
 +
 
 +
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_render -->
 +
===render===
 +
 
 +
<source lang="perl">( $description, $title, $links ) = $eprint->render
 +
 
 +
</source>
 +
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.
 +
 
 +
Calls [[API:EPrints/DataObj/EPrint#eprint_render|eprint_render]] to actually render the <code>$eprint</code>, if it isn't deleted.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_control_url -->
 +
===get_control_url===
 +
 
 +
<source lang="perl">$url = $eprint->get_control_url
 +
 
 +
</source>
 +
Return the URL of the control page for this eprint.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_url -->
 +
===get_url===
 +
 
 +
<source lang="perl">$url = $eprint->get_url
 +
 
 +
</source>
 +
Return the public URL of this eprints abstract page.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_user -->
 +
===get_user===
 +
 
 +
<source lang="perl">$user = $eprint->get_user
 +
 
 +
</source>
 +
Return the EPrints::DataObj::User to whom this eprint belongs (if any).
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_in_thread -->
 +
===in_thread===
 +
 
 +
<source lang="perl">$bool = $eprint->in_thread( $field )
 +
 
 +
</source>
 +
Returns true if this eprint is in the $field thread.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_first_in_thread -->
 +
===first_in_thread===
 +
 
 +
<source lang="perl">$eprint = $eprint->first_in_thread( $field )
 +
 
 +
</source>
 +
Return the first (earliest) version or first paper in the thread of commentaries of this paper in the repository.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_last_in_thread -->
 +
===last_in_thread===
 +
 
 +
<source lang="perl">$eprint = $eprint->last_in_thread( $field )
 +
 
 +
</source>
 +
Returns the latest item in the $field thread on this eprint's branch of the thread tree.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_render_version_thread -->
 +
===render_version_thread===
 +
 
 +
<source lang="perl">$xhtml = $eprint->render_version_thread( $field )
 +
 
 +
</source>
 +
Render XHTML DOM describing the entire thread as nested unordered lists.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_type -->
 +
===get_type===
 +
 
 +
<source lang="perl">$type = $eprint->get_type
 +
 
 +
</source>
 +
Return the type of this eprint.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_user_roles -->
 +
===user_roles===
 +
 
 +
<source lang="perl">@roles = $eprint->user_roles( $user )
 +
 
 +
</source>
 +
Return the @roles $user has on $eprint.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_in_editorial_scope_of -->
 +
===in_editorial_scope_of===
 +
 
 +
<source lang="perl">$boolean = $eprint->in_editorial_scope_of( $possible_editor )
 +
 
 +
</source>
 +
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.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_has_owner -->
 +
===has_owner===
 +
 
 +
<source lang="perl">$boolean = $eprint->has_owner( $possible_owner )
 +
 
 +
</source>
 +
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.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_obtain_lock -->
 +
===obtain_lock===
 +
 
 +
<source lang="perl">$boolean = $eprint->obtain_lock( $user )
 +
 
 +
</source>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_remove_lock -->
 +
===remove_lock===
 +
 
 +
<source lang="perl">$boolean = $eprint->remove_lock( $user )
 +
 
 +
</source>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_could_obtain_lock -->
 +
===could_obtain_lock===
 +
 
 +
<source lang="perl">$boolean = $eprint->could_obtain_lock( $user )
 +
 
 +
</source>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_is_locked -->
 +
===is_locked===
 +
 
 +
<source lang="perl">$boolean = $eprint->is_locked()
 +
 
 +
</source>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_render_edit_lock -->
 +
===render_edit_lock===
 +
 
 +
<source lang="perl">$xhtml = render_edit_lock( $session, $value )
 +
 
 +
</source>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_callbacks -->
 +
==CALLBACKS==
 +
Callbacks may optionally be defined in the ArchiveConfig.
 +
 
 +
* validate_field
 +
<pre>  validate_field( $field, $value, $session, [$for_archive] )</pre>
 +
 
 +
* validate_eprint
 +
<pre>  validate_eprint( $eprint, $session, [$for_archive] )</pre>
 +
 
 +
* set_eprint_defaults
 +
<pre>  set_eprint_defaults( $data, $session )</pre>
 +
 
 +
* set_eprint_automatic_fields
 +
<pre>  set_eprint_automatic_fields( $eprint )</pre>
 +
 
 +
* eprint_render
 +
<pre>  eprint_render( $eprint, $session )</pre>
 +
 
 +
: See {{API:PodLink|file=ArchiveRenderConfig|package_name=ArchiveRenderConfig|section=eprint_render|text=ArchiveRenderConfig/eprint_render}}.
 +
 
 +
<pre>
 +
 
 +
 
 +
 
 +
</pre>
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
Copyright 2000-2011 University of Southampton.
 +
 
 +
This file is part of EPrints http://www.eprints.org/.
 +
 
 +
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 +
 
 +
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 +
 
 +
You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=_postamble_ -->
 +
<!-- Edit below this comment -->

Latest revision as of 09:57, 22 January 2013

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

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


NAME

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


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):


SYSTEM METADATA

  • eprintid (int)
The unique numerical ID of this eprint.
  • rev_number (int)
The number of the current revision of this record.
  • userid (itemref)
The id of the user who deposited this eprint (if any). Scripted importing could cause this not to be set.
  • 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.
  • datestamp (time)
The date this record first appeared live in the repository.
  • lastmod (time)
The date this record was last modified.
  • status_changes (time)
The date/time this record was moved between inbox, buffer, archive, etc.
  • type (namedset)
The type of this record, one of the types of the "eprint" dataset.
  • 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.
  • 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.
  • metadata_visibility (set)
This field is automatically set.
  show - appears normally
  no_search - hidden from search/views
The 'hide' option may be used to force an eprint to not appear in search/views but is not considered a stable option.


METHODS

get_system_field_info

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

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


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').


get_dataset_id

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

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


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.


get_defaults

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

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


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.


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.


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


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".


commit

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

Commit any changes to the database.

Calls update_triggers just before the database is updated.

The actions this method does are dependent on some object attributes:

  changed - HASH of changed fields (from [[API:EPrints/DataObj|EPrints::DataObj]])
  non_volatile_change - BOOL (from [[API:EPrints/DataObj|EPrints::DataObj]])
  under_construction - BOOL

If datestamp is unset and this eprint is in the archive dataset datestamp will always be set which will in turn set datestamp as changed.

If no field values were changed and $force is false returns.

If under_construction is false:

- static files updated

If non_volatile_change is true:

- lastmod field updated
- triples update queued

If under_construction is false and non_volatile_change is true:

- revision generated

The goal of these controls is to only trigger expensive processes in response to user actions. Revisions need to be generated when the user changes metadata or uploads new files (see EPrints::DataObj::Document/commit).


save_revision

$eprint->save_revision( %opts )

Increase the eprint revision number and save a complete copy of the record into the history (see EPrints::DataObj::History).

Options:

  user - user that caused the action to occur, defaults to current user
  action - see history.action, defaults to "modify"
  details - see history.details, defaults to a description of changed fields


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.


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.


prune_documents

$eprint->prune_documents

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


get_all_documents

@documents = $eprint->get_all_documents

Return a list of all EPrint::Document objects associated with this eprint excluding documents with a "isVolatileVersionOf" relation (e.g. thumbnails).


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.


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.


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.


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.


local_path

$path = $eprint->local_path

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


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.


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.


remove_static

$eprint->remove_static

Remove the static web page or pages.


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.


get_control_url

$url = $eprint->get_control_url

Return the URL of the control page for this eprint.


get_url

$url = $eprint->get_url

Return the public URL of this eprints abstract page.


get_user

$user = $eprint->get_user

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


in_thread

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

Returns true if this eprint is in the $field thread.


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.


last_in_thread

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

Returns the latest item in the $field thread on this eprint's branch of the thread tree.


render_version_thread

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

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


get_type

$type = $eprint->get_type

Return the type of this eprint.


user_roles

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

Return the @roles $user has on $eprint.


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.


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.


obtain_lock

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


remove_lock

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


could_obtain_lock

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


is_locked

$boolean = $eprint->is_locked()


render_edit_lock

$xhtml = render_edit_lock( $session, $value )


CALLBACKS

Callbacks may optionally be defined in the ArchiveConfig.

  • validate_field
  validate_field( $field, $value, $session, [$for_archive] )
  • validate_eprint
  validate_eprint( $eprint, $session, [$for_archive] )
  • set_eprint_defaults
  set_eprint_defaults( $data, $session )
  • set_eprint_automatic_fields
  set_eprint_automatic_fields( $eprint )
  • eprint_render
  eprint_render( $eprint, $session )
See ArchiveRenderConfig/eprint_render.
  

  


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