API:EPrints/DataObj/EPrint

From EPrints Documentation
Revision as of 18:28, 11 August 2009 by Tdb01r (Talk | contribs)

Jump to: navigation, search

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

 eprintid (int)

The unique numerical ID of this eprint.

rev_number

 rev_number (int)

The number of the current revision of this record.

userid

 userid (itemref)

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

dir

 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

 datestamp (time)

The date this record first appeared live in the repository.

lastmod

 lastmod (time)

The date this record was last modified.

status_changes

 status_changes (time)

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

type

 type (namedset)

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

succeeds

 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

 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.

replacedby

 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.

METHODS

get_system_field_info

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

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

new

 $eprint = EPrints::DataObj::EPrint->new( $session, $eprint_id )

Return the eprint with the given eprint_id, or undef if it does not exist.

new_from_data

 $eprint = EPrints::DataObj::EPrint->new_from_data( $session, $data, $dataset )

Construct a new EPrints::DataObj::EPrint object based on the $data hash reference of metadata.

get_gid

 $dataset = $eprint->get_gid

Returns the OAI identifier for this eprint.

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

write_revision

 $eprint->write_revision

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

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.

get_warnings

 $warnings = $eprint->get_warnings

Return a reference to an array of XHTML DOM objects describing warnings about this eprint - that is things that are not quite validation errors, but it'd be nice if they were fixed.

Calls /eprint_warnings 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 an array of all EPrint::Document objects associated with this eprint.

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.

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.

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.

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.

render_history

 ( $html ) = $eprint->render_history

Render the history of this eprint as XHTML DOM.

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::User to whom this eprint belongs (if any).

eprintid_to_path

 $path = EPrints::DataObj::EPrint::eprintid_to_path( $eprintid )

Return this eprints id converted into directories. Thousands of files in one directory cause problems. For example, the eprint with the id 50344 would have the path 00/05/03/44.

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.

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

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.

later_in_thread

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

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

all_in_thread

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

Return all of the EPrints in the given thread.

last_in_thread

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

Return the last item in the specified thread.

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.

render_version_thread

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

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

loop_error

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

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

get_type

 $type = $eprint->get_type

Return the type of this eprint.

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_roles

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

Return the @roles $user has on $eprint.

datestamp

 $eprint->datestamp

DEPRECATED.

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.

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.

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

create

create_from_data

order_issues_newest_open_timestamp

render_box_list

render_fileinfo

render_issues

render_preview

succeed_thread_modified