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

From EPrints Documentation
Jump to: navigation, search
 
(10 intermediate revisions by 2 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.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
−
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Document.pm|package_name=EPrints::DataObj::Document}}[[Category:API|DOCUMENT]][[Category:API:EPrints/DataObj|DOCUMENT]][[Category:API:EPrints/DataObj/Document|DOCUMENT]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Document.pm|package_name=EPrints::DataObj::Document}}[[Category:API|DOCUMENT]][[Category:API:EPrints/DataObj|DOCUMENT]]<div><!-- Edit below this comment -->
  
  
Line 19: Line 19:
 
Document represents a single format of an EPrint (eg. PDF) - the  actual file(s) rather than the metadata.
 
Document represents a single format of an EPrint (eg. PDF) - the  actual file(s) rather than the metadata.
  
−
This class is a subclass of DataObj, with the following metadata fields:  
+
Inherits from [[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]], which in turn inherits from [[API:EPrints/DataObj|EPrints::DataObj]].
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_instance_variables -->
 +
==INSTANCE VARIABLES==
 +
See [[API:EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj#INSTANCE_VARIABLES]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_core_metadata_fields -->
 +
==CORE METADATA FIELDS==
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 29: Line 49:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_docid -->
 
<!-- Pod2Wiki=item_docid -->
−
===docid (text)===
+
===docid (int)===
  
−
The unique ID of the document. This is a string of the format 123-02 where the first number is the eprint id and the second is the document number within that eprint.
+
The unique ID of the document.  
  
−
This should probably have been and "int" but isn't. I later version of EPrints may change this.
+
<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_rev_number -->
 +
===rev_number (int)===
 +
 
 +
The revision number of this document record.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 42: Line 72:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_eprintid -->
+
<!-- Pod2Wiki=item_pos -->
−
===eprintid (itemref)===
+
===pos (int)===
  
−
The id number of the eprint to which this document belongs.
+
The position of the document record within those associated with 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%; '>
Line 57: Line 87:
 
===placement (int)===
 
===placement (int)===
  
−
Placement of the document - the order documents should be shown in.
+
Placement of the document - the order documents in which should be shown.  This may be different to <tt>pos</tt>, as the <tt>ultimate_doc_pos</tt>  may lead to a different ordering.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 69: Line 99:
 
===format (namedset)===
 
===format (namedset)===
  
−
The format of this document. One of the types of the dataset "document".
+
The format of this document. One of the types of the namedset c&lt;document&gt;.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 81: Line 111:
 
===formatdesc (text)===
 
===formatdesc (text)===
  
−
An additional description of this document. For example the specific version of a format.
+
An additional description of this document. For example the specific version of a format.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 93: Line 123:
 
===language (namedset)===
 
===language (namedset)===
  
−
The ISO ID of the language of this document. The default configuration of EPrints does not set this.
+
The ISO 639-1 code of the language of this document. The default configuration of EPrints does not set this.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 105: Line 135:
 
===security (namedset)===
 
===security (namedset)===
  
−
The security type of this document - who can view it. One of the types of the dataset "security".
+
The security type of this document - who can view it. One of the types of the namedset <tt>security</tt>.
 +
 
 +
<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_license -->
 +
===license (namedset)===
 +
 
 +
The license applied of this document - who can view it. One of the  types of the namedset <tt>license</tt>.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 118: Line 160:
  
 
The file which we should link to. For something like a PDF file this is the only file. For an HTML document with images it would be the name of the actual HTML file.
 
The file which we should link to. For something like a PDF file this is the only file. For an HTML document with images it would be the name of the actual HTML file.
 +
 +
<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_date_embargo -->
 +
===date_embargo (date)===
 +
 +
The date until which the document has restricted access (set by  <tt>security</tt>).  At which point the embargo is lifted and <tt>security</tt> is set to <tt>public</tt> and this field set back to <tt>undef</tt>.
 +
 +
Requires <tt>bin/lift_embargos</tt> script to be deployed as a cron job.
 +
 +
<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_date_embargo_retained -->
 +
===date_embargo_retained (date)===
 +
 +
The retained date of any embargo originally placed on this document. This is updated when a user modifies <tt>date_embargo</tt> but is not unset by the <tt>bin/lift_embargos</tt> script.
 +
 +
<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_media -->
 +
===media (compound)===
 +
 +
A compound field containing a description of the document media - dimensions, codec etc.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_references_and_related_objects -->
 +
==REFERENCES AND RELATED OBJECTS ==
 +
<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_eprintid -->
 +
===eprintid (itemref)===
 +
 +
The ID number of the eprint to which this document 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%; '>
Line 129: Line 230:
 
===files (subobject, multiple)===
 
===files (subobject, multiple)===
  
−
A virtual field which represents the list of Files which are part of this record.
+
A virtual field which represents the list of files which are part of this record.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 138: Line 239:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_media -->
+
<!-- Pod2Wiki=item_relation -->
−
===media===
+
===relation (relation, multiple)===
  
−
A compound field containing a description of the document media - dimensions, codec etc.
+
Predicated relationships between this document and other data objects within the archive.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 152: Line 253:
 
<!-- Pod2Wiki=head_methods -->
 
<!-- 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%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_constructor_methods -->
 +
===Constructor Methods===
 +
<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_create -->
 +
====create====
 +
 +
$doc = EPrints::DataObj::Document::create( $session, $eprint )
 +
Create and return a new document belonging to the given <tt>$eprint</tt>  object.
 +
 +
N.B. This creates the document in the database, not just in memory.
 +
 +
<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_create_from_data -->
 +
====create_from_data====
 +
 +
$dataobj = EPrints::DataObj::Document::create_from_data( $session, $data, $dataset )
 +
Create document data object from <tt>$data</tt> provided.
 +
 +
Returns <tt>undef</tt> if a bad (or no) <tt>eprintid</tt> specified in <tt>$data</tt>.
 +
 +
Otherwise calls the parent method in [[API:EPrints/DataObj|EPrints::DataObj]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_class_methods -->
 +
===Class 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%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 160: Line 311:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_system_field_info -->
 
<!-- Pod2Wiki=item_get_system_field_info -->
−
===get_system_field_info===
+
====get_system_field_info====
 +
 
 +
$fields = EPrints::DataObj::Document-&gt;get_system_field_info
 +
Returns an array describing the system metadata of the document  dataset.
 +
 
 +
<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_defaults -->
 +
====get_defaults====
  
−
  $metadata = EPrints::DataObj::Document-&gt;get_system_field_info
+
  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $session, $data, $dataset )
−
Return an array describing the system metadata of the Document dataset.
+
Returns default values for this data object based on the starting  <tt>$data</tt>.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 173: Line 337:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_dataset_id -->
 
<!-- Pod2Wiki=item_get_dataset_id -->
−
===get_dataset_id===
+
====get_dataset_id====
  
 
  $dataset = EPrints::DataObj::Document-&gt;get_dataset_id
 
  $dataset = EPrints::DataObj::Document-&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%; '>
Line 185: Line 349:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_get_defaults -->
+
<!-- Pod2Wiki=item_get_parent_dataset_id -->
−
===get_defaults===
+
====get_parent_dataset_id====
  
−
  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $session, $data )
+
  $dataset_id = EPrints::DataObj::Document-&gt;get_parent_dataset_id
−
Return default values for this object based on the starting data.
+
Returns the ID of the parent dataset for a document, (i.e. <tt>eprint</tt>).
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_object_methods -->
 +
===Object 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%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 199: Line 372:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_clone -->
 
<!-- Pod2Wiki=item_clone -->
−
===clone===
+
====clone====
  
 
  $newdoc = $doc-&gt;clone( $eprint )
 
  $newdoc = $doc-&gt;clone( $eprint )
−
Attempt to clone this document. Both the document metadata and the actual files. The clone will be associated with the given EPrint.
+
Attempt to clone this document. Both the document metadata and the actual files. The clone will be associated with the given <tt>$eprint</tt>.
 +
 
 +
Returns to the newly colument document.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 212: Line 387:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_remove -->
 
<!-- Pod2Wiki=item_remove -->
−
===remove===
+
====remove====
  
 
  $success = $doc-&gt;remove
 
  $success = $doc-&gt;remove
−
Attempt to completely delete this document
+
Attempt to completely delete this document. Including derived  documents such as thumbnails.
 +
 
 +
Returns boolean dependent on success of deleting document.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 225: Line 402:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_eprint -->
 
<!-- Pod2Wiki=item_get_eprint -->
−
===get_eprint===
+
====get_eprint====
  
 
  $eprint = $doc-&gt;get_eprint
 
  $eprint = $doc-&gt;get_eprint
−
Return the EPrint this document is associated with.
+
Returns the eprint this document is associated with.
  
−
This is a synonym for get_parent().
+
Alias for:
  
 +
$doc-&gt;get_parent
 +
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 240: Line 419:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_baseurl -->
 
<!-- Pod2Wiki=item_get_baseurl -->
−
===get_baseurl===
+
====get_baseurl====
  
−
  $url = $doc-&gt;get_baseurl( [$staff] )
+
  $url = $doc-&gt;get_baseurl
−
Return the base URL of the document. Overrides the stub in DataObj. $staff is currently ignored.
+
Returns the base URL of the document.  
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 253: Line 432:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_is_public -->
 
<!-- Pod2Wiki=item_is_public -->
−
===is_public===
+
====is_public====
 +
 
 +
$boolean = $doc-&gt;is_public
 +
Returnes <tt>true</tt> if this document has no security set and is in the  live archive. Otherwise, returns <tt>false</tt>.
 +
 
 +
<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_path -->
 +
====path====
 +
 
 +
$path = $doc-&gt;path
 +
Returns the relative path to the document without specifying any file.
 +
 
 +
<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_file_path -->
 +
====file_path====
 +
 
 +
$path = $doc-&gt;file_path( [ $file ] )
 +
Returns the relative path to <tt>$file</tt> stored in this document.  If <tt>$file</tt> is undefined returns the path to the main file.
  
−
$boolean = $doc-&gt;is_public()
+
This is an efficient shortcut to this:
−
True if this document has no security set and is in the live archive.
 
  
 +
my $file = $doc-&gt;stored_file( $filename );
 +
my $path = $file-&gt;path;
 +
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 266: Line 476:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_url -->
 
<!-- Pod2Wiki=item_get_url -->
−
===get_url===
+
====get_url====
  
−
  $url = $doc-&gt;get_url( [$file] )
+
  $url = $doc-&gt;get_url( [ $file ] )
−
Return the full URL of the document. Overrides the stub in DataObj.
+
Returns the full URL of the document.
  
−
If file is not specified then the "main" file is used.
+
If <tt>$file</tt> is not specified then the main file is used.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 281: Line 491:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_local_path -->
 
<!-- Pod2Wiki=item_local_path -->
−
===local_path===
+
====local_path====
  
 
  $path = $doc-&gt;local_path
 
  $path = $doc-&gt;local_path
−
Return the full path of the directory where this document is stored in the filesystem.
+
DEPRECATED.
 +
 
 +
Returns the full path of the directory where this document is stored in the filesystem.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 294: Line 506:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_files -->
 
<!-- Pod2Wiki=item_files -->
−
===files===
+
====files====
  
 
  %files = $doc-&gt;files
 
  %files = $doc-&gt;files
−
Return a hash, the keys of which are all the files belonging to this document (relative to $doc-&gt;local_path). The values are the sizes of the files, in bytes.
+
Returns a hash, the keys of which are all the files belonging to this document (relative to [[API:EPrints/DataObj/Document#local_path|local_path]]). The values are the sizes of the files in bytes.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 307: Line 519:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_remove_file -->
 
<!-- Pod2Wiki=item_remove_file -->
−
===remove_file===
+
====remove_file====
  
 
  $success = $doc-&gt;remove_file( $filename )
 
  $success = $doc-&gt;remove_file( $filename )
−
Attempt to remove the given file. Give the filename as it is returned by get_files().
+
Attempts to remove the file with <tt>$filename</tt>. <tt>$filename</tt> must be  specified in the format that can be retrieved by [[API:EPrints/DataObj/Document#get_stored_file|get_stored_file]].
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 320: Line 532:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_set_main -->
 
<!-- Pod2Wiki=item_set_main -->
−
===set_main===
+
====set_main====
  
 
  $doc-&gt;set_main( $main_file )
 
  $doc-&gt;set_main( $main_file )
−
Sets the main file. Won't affect the database until a $doc-&gt;commit().
+
Sets <tt>main</tt> for the document to the named <tt>$main_file</tt> and adjusts  <tt>format</tt> and <tt>mime_type</tt> as necessary. Will not affect the database until the document is committed.
 +
 +
Unsets <tt>main</tt> if <tt>$main_file</tt> is undefined.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 333: Line 547:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_main -->
 
<!-- Pod2Wiki=item_get_main -->
−
===get_main===
+
====get_main====
  
 
  $filename = $doc-&gt;get_main
 
  $filename = $doc-&gt;get_main
−
Return the name of the main file in this document.
+
Returns the filename of the file set as <tt>main</tt> in this document.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 346: Line 560:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_set_format -->
 
<!-- Pod2Wiki=item_set_format -->
−
===set_format===
+
====set_format====
  
 
  $doc-&gt;set_format( $format )
 
  $doc-&gt;set_format( $format )
−
Set format. Won't affect the database until a commit(). Just an alias  for $doc-&gt;set_value( "format" , $format );
+
Set format for document to <tt>$format</tt>. Will not affect the database until document is committed.  
 +
 
 +
Alias for:
  
 +
$doc-&gt;set_value( "format" , $format );
 +
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 359: Line 577:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_set_format_desc -->
 
<!-- Pod2Wiki=item_set_format_desc -->
−
===set_format_desc===
+
====set_format_desc====
  
 
  $doc-&gt;set_format_desc( $format_desc )
 
  $doc-&gt;set_format_desc( $format_desc )
−
Set the format description.  Won't affect the database until a commit(). Just an alias for $doc-&gt;set_value( "format_desc" , $format_desc );
+
Set format description for document to <tt>$format_desc</tt>. Will not affect the database until document is committed.
 +
 
 +
Alias for:
  
 +
$doc-&gt;set_value( "format_desc" , $format_desc );
 +
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 372: Line 594:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_upload -->
 
<!-- Pod2Wiki=item_upload -->
−
===upload===
+
====upload====
  
−
  $success = $doc-&gt;upload( $filehandle, $filename [, $preserve_path [, $filesize ] ] )
+
  $success = $doc-&gt;upload( $filehandle, $filename, [ $preserve_path, $filesize ] )
−
Upload the contents of the given file handle into this document as the given filename.
+
DEPRECATED - Use [[API:EPrints/DataObj/Document#add_file|add_file]], which will automatically identify the file type.
  
−
If $preserve_path then make any subdirectories needed, otherwise place this in the top level.
+
Upload the contents of the given <tt>$filehandle</tt> into this document as the given <tt>$filename</tt>.
 +
 
 +
If <tt>$preserve_path</tt> then make any subdirectories needed, otherwise place this in the top level directory.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 387: Line 611:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_add_file -->
 
<!-- Pod2Wiki=item_add_file -->
−
===add_file===
+
====add_file====
−
 
 
−
$success = $doc-&gt;add_file( $file, $filename, [$preserve_path] )
 
−
$file is the full path to a file to be added to the document, with name $filename.
 
−
 
 
−
If $preserve_path then keep the filename as is (including subdirs and spaces)
 
−
 
 
−
<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 -->
 
  
 +
$fileobj = $doc-&gt;add_file( $file, $filename, [ $preserve_path ] )
 +
<tt>$file</tt> is the full path to a file to be added to the document, with name <tt>$filename</tt>. <tt>$filename</tt> is passed through  [[API:EPrints/System#sanitise|EPrints::System#sanitise]] before being written.
  
−
<!-- Pod2Wiki= -->
+
If <tt>$preserve_path</tt> is <tt>tru</tt>e then include path components in  <tt>$filename</tt>.
−
</div>
 
−
<!-- Pod2Wiki=item_sanitise -->
 
−
===sanitise===
 
  
−
  $cleanfilename = sanitise( $filename )
+
Returns the file object if successfully created or <tt>undef</tt> on failure.
−
Return just the filename (no leading path) and convert any naughty characters to underscore.
 
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 415: Line 628:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_upload_archive -->
 
<!-- Pod2Wiki=item_upload_archive -->
−
===upload_archive===
+
====upload_archive====
  
 
  $success = $doc-&gt;upload_archive( $filehandle, $filename, $archive_format )
 
  $success = $doc-&gt;upload_archive( $filehandle, $filename, $archive_format )
−
Upload the contents of the given archive file. How to deal with the  archive format is configured in SystemSettings.  
+
DEPRECATED - use [[API:EPrints/DataObj/Document#add_archive|add_archive]].
  
−
(In case the over-loading of the word "archive" is getting confusing, in this context we mean ".zip" or ".tar.gz" archive.)
+
Upload the file contents provided through <tt>$filehandle</tt> using the filename from <tt>$filename</tt>. How to deal with the specified <tt>$archive_format</tt> (e.g. <tt>.zip</tt>, <tt>.tar.gz</tt>) is configured in  [[API:EPrints/SystemSettings|EPrints::SystemSettings]].  
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 430: Line 643:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_add_archive -->
 
<!-- Pod2Wiki=item_add_archive -->
−
===add_archive===
+
====add_archive====
  
 
  $success = $doc-&gt;add_archive( $file, $archive_format )
 
  $success = $doc-&gt;add_archive( $file, $archive_format )
−
$file is the full path to an archive file, eg. zip or .tar.gz  
+
Adds the contents of that archive <tt>$file</tt> to the document, where  <tt>$archive_format</tt> is the format of the archive file (e.g. <tt>.zip</tt>, <tt>.tar.gz</tt>, etc.)
  
−
This function will add the contents of that archive to the document.
+
Returns a boolean dependent on whether the contents of the archive file is added to the document's subdirectory on the filesystem.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 445: Line 658:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_add_directory -->
 
<!-- Pod2Wiki=item_add_directory -->
−
===add_directory===
+
====add_directory====
  
 
  $success = $doc-&gt;add_directory( $directory )
 
  $success = $doc-&gt;add_directory( $directory )
−
Upload the contents of $directory to this document. This will not set the main file.
+
Upload the contents of <tt>$directory</tt> to this document. This will not set the document's <tt>main</tt> field.
 +
 
 +
This method expects <tt>$directory</tt> to have a trailing slash <tt>/</tt>.
  
−
This method expects $directory to have a trailing slash (/).
+
Returns boolean depending on success of adding directory to document.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 460: Line 675:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_upload_url -->
 
<!-- Pod2Wiki=item_upload_url -->
−
===upload_url===
+
====upload_url====
  
 
  $success = $doc-&gt;upload_url( $url )
 
  $success = $doc-&gt;upload_url( $url )
−
Attempt to grab stuff from the given URL. Grabbing HTML stuff this way is always problematic, so (by default): only relative links will be followed and only links to files in the same directory or subdirectory will be followed.
+
Attempts to grab files from the given <tt>$url</tt> over HTTP. Grabbing files this way is always problematic. Therefore, by default, only relative links will be followed and only links to files in the same directory or subdirectory will be followed.
  
−
This (by default) uses wget. The details can be configured in SystemSettings.
+
This method by default uses {{API:PodLink|file=https:|package_name=https:|section=|text=wget}}. However, you can modify this in [[API:EPrints/SystemSettings|EPrints::SystemSettings]].
 +
 
 +
Returns a boolean dependent of whether file(s) were successfully uploaded.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 475: Line 692:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_commit -->
 
<!-- Pod2Wiki=item_commit -->
−
===commit===
+
====commit====
  
−
  $success = $doc-&gt;commit
+
  $success = $doc-&gt;commit( [ $force ] )
−
Commit any changes that have been made to this object to the database.
+
Commit any changes that have been made to this data object to the database.
  
−
Calls "set_document_automatic_fields" in the ArchiveConfig first to set any automatic fields that may be needed.
+
Calls <tt>set_document_automatic_fields</tt> in the archive's configuration  first to set any automatic fields that may be needed.
 +
 
 +
If <tt>$force</tt> is defined and <tt>true</tt> then still commit even if there  are no non-volatile changes.
 +
 
 +
Returns boolean depending on whether commit of document data object is successful.
 +
 
 +
<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_derived_versions -->
 +
====get_derived_versions====
 +
 
 +
@derived_docs = $doc-&gt;get_derived_versions
 +
Returns an array of documents that are derived from the current document through the <tt>isVersionOf</tt> relation.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 490: Line 724:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_validate -->
 
<!-- Pod2Wiki=item_validate -->
−
===validate===
+
====validate====
 +
 
 +
$problems = $doc-&gt;validate( [ $for_archive ] )
 +
Validates the document data object.  If <tt>$for_archive</tt> is defined  this will be passed through to the archive configured  <tt>validate_document</tt> method, in case it is required for bespoke  changes to this method.
  
−
$problems = $doc-&gt;validate( [$for_archive] )
+
Returns a reference to an array of XHTML DOM objects describing validation problems with the entire document, including the metadata and repository config specific requirements.
−
Return an array of XHTML DOM objects describing validation problems with the entire document, including the metadata and repository config specific requirements.
 
  
−
A reference to an empty array indicates no problems.
+
A returned reference to an empty array indicates no problems.
 +
 
 +
<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_user_can_view -->
 +
====user_can_view====
 +
 
 +
$boolean = $doc-&gt;user_can_view( $user )
 +
Returns <tt>true</tt> if this document's security settings allow the given  <tt>$user</tt> access to view it.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 505: Line 754:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_type -->
 
<!-- Pod2Wiki=item_get_type -->
−
===get_type===
+
====get_type====
  
 
  $type = $doc-&gt;get_type
 
  $type = $doc-&gt;get_type
−
Return the type of this document.
+
Returns the type of this document.
 +
 
 +
Alias for:
 +
 
 +
$doc-&gt;value( "format" );
 +
 
 +
<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_queue_files_modified -->
 +
====queue_files_modified====
 +
 
 +
$doc-&gt;queue_files_modified
 +
Adds a <tt>files_modified</tt> task (e.g. for creating/updating thumbnails) to the event queue.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 518: Line 784:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_files_modified -->
 
<!-- Pod2Wiki=item_files_modified -->
−
===files_modified===
+
====files_modified====
  
 
  $doc-&gt;files_modified
 
  $doc-&gt;files_modified
Line 531: Line 797:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_rehash -->
 
<!-- Pod2Wiki=item_rehash -->
−
===rehash===
+
====rehash====
  
 
  $doc-&gt;rehash
 
  $doc-&gt;rehash
−
Recalculate the hash value of the document. Uses MD5 of the files (in alphabetic order), but can use user specified hashing function instead.
+
Recalculate the hash value of the document. Uses MD5 of the files (in alphabetic order), but can use user-specified hashing function instead.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 544: Line 810:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_make_indexcodes -->
 
<!-- Pod2Wiki=item_make_indexcodes -->
−
===make_indexcodes===
+
====make_indexcodes====
  
−
  $doc = $doc-&gt;make_indexcodes()
+
  $indexcodes_doc = $doc-&gt;make_indexcodes
−
Make the indexcodes document for this document. Returns the generated document or undef on failure.
+
Make the index codes document for this document. Returns the generated index codes document on success or <tt>undef</tt> on failure.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 557: Line 823:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_remove_indexcodes -->
 
<!-- Pod2Wiki=item_remove_indexcodes -->
−
===remove_indexcodes===
+
====remove_indexcodes====
  
−
  $doc = $doc-&gt;remove_indexcodes()
+
  $doc = $doc-&gt;remove_indexcodes
−
Remove any documents containing index codes for this document. Returns the number of documents removed.
+
Remove any documents containing index codes for this document. Returns the number of documents removed.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 570: Line 836:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_cache_file -->
 
<!-- Pod2Wiki=item_cache_file -->
−
===cache_file===
+
====cache_file====
  
 
  $filename = $doc-&gt;cache_file( $suffix );
 
  $filename = $doc-&gt;cache_file( $suffix );
−
Return a cache filename for this document with the givven suffix.
+
DEPRECATED
 +
 
 +
Returns a cache filename for this document with the given <tt>$suffix</tt>.
 +
 
 +
<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_register_parent -->
 +
====register_parent====
 +
 
 +
$doc-&gt;register_parent( $parent )
 +
Registers the <tt>$parent</tt> [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]] object for this  document.
 +
 
 +
This may cause reference loops, but it does avoid two identical eprint data objects existing at once.
 +
 
 +
<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_thumbnail_url -->
 +
====thumbnail_url====
 +
 
 +
$doc-&gt;thumbnail_url( $size )
 +
Returns the URL for the thumbnail of the document for a specified <tt>$size</tt>.  If <tt>$size</tt> is unspecified defaults to <tt>small</tt>. Other  values for <tt>$size</tt> include <tt>medium</tt> and <tt>preview</tt>.
 +
 
 +
Returns <tt>undef</tt> if file for particular type of thumbnail does not exist.
 +
 
 +
This method is called bt [[API:EPrints/DataObj/Document#icon_url|icon_url]].  It is best to use that method to reliably retrieve the required 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_icon_url -->
 +
====icon_url====
 +
 
 +
$doc-&gt;icon_url( $size )
 +
Returns the URL for the icon of the document for a specified <tt>$size</tt>.  If <tt>$size</tt> is unspecified defaults to <tt>small</tt>. Other values for <tt>$size</tt> include <tt>medium</tt> and <tt>preview</tt>.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 583: Line 896:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_render_icon_link -->
 
<!-- Pod2Wiki=item_render_icon_link -->
−
===render_icon_link===
+
====render_icon_link====
  
 
  $frag = $doc-&gt;render_icon_link( %opts )
 
  $frag = $doc-&gt;render_icon_link( %opts )
Line 589: Line 902:
  
 
Options:
 
Options:
 +
 +
new_window =&gt; 1 - Make link go to <tt>_blank</tt> not current window.
 +
 
 +
preview =&gt; 1 - If possible, provide a preview pop-up.
 +
 
 +
public =&gt; 0 - Show thumbnail/preview only on public documents.
 +
 
 +
public =&gt; 1 - Show thumbnail/preview on all documents if possible.
 +
 
 +
with_link =&gt; 0 - Do not link.
 +
 
 +
<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_render_preview_link -->
 +
====render_preview_link====
 +
 +
$frag = $doc-&gt;render_preview_link( %opts )
 +
Render a link to the preview for this document (if available) using a  lightbox.
 +
 +
Options:
 +
 +
<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_caption_frag -->
 +
====caption_frag====
 +
 +
caption =&gt; $frag
 +
XHTML fragment to use as the caption, defaults to empty.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 597: Line 948:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_new_window_1 -->
+
<!-- Pod2Wiki=item_set_name -->
−
===new_window_1===
+
====set_name====
  
−
  new_window =&gt; 1
+
  set =&gt; "name"
−
Make link go to _blank not current window.
+
The name of the set this document belongs to, defaults to none  (preview won't be shown as part of a set).
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 610: Line 961:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_preview_1 -->
+
<!-- Pod2Wiki=item_thumbnail_plugin -->
−
===preview_1===
+
====thumbnail_plugin====
  
−
  preview =&gt; 1
+
  $plugin = $doc-&gt;thumbnail_plugin( $size )
−
If possible, provide a preview pop-up.
+
Returns the plugin used to generatee thumbnails of the specified  <tt>$size</tt>.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 623: Line 974:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_public_0 -->
+
<!-- Pod2Wiki=item_thumbnail_path -->
−
===public_0===
+
====thumbnail_path====
 +
 
 +
$path = $doc-&gt;thumbnail_path
 +
DEPRECATED
  
−
  public =&gt; 0
+
Returns the filesystem path to location of thumbnails for the document.
−
Show thumbnail/preview only on public docs.
 
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 636: Line 989:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_public_1 -->
+
<!-- Pod2Wiki=item_thumbnail_types -->
−
===public_1===
+
====thumbnail_types====
  
−
  public =&gt; 1
+
  $doc-&gt;thumbnail_types
−
Show thumbnail/preview on all docs if poss.
+
Returns array containing names of all the thumbnail types available  for this document.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 649: Line 1,002:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_render_preview_link -->
+
<!-- Pod2Wiki=item_remove_thumbnails -->
−
===render_preview_link===
+
====remove_thumbnails====
 +
 
 +
$doc-&gt;remove_thumbnails
 +
Removes all thumbnail files associated with this document.
 +
 
 +
<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 -->
 +
 
  
−
$frag = $doc-&gt;render_preview_link( %opts )
+
<!-- Pod2Wiki= -->
−
Render a link to the preview for this document (if available) using a lightbox.
+
</div>
 +
<!-- Pod2Wiki=item_make_thumbnails -->
 +
====make_thumbnails====
  
−
Options:
+
$doc-&gt;make_thumbnails
 +
Make all the thumbnail files required for this document.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 664: Line 1,028:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_caption_frag -->
+
<!-- Pod2Wiki=item_mime_type -->
−
===caption_frag===
+
====mime_type====
 +
 
 +
$mime_type = $doc-&gt;mime_type
 +
DEPRECATED - use <tt>$doc-&gt;value( "mime_type" )</tt>
  
−
caption =&gt; $frag
+
Returns the MIME type of this document.
−
XHTML fragment to use as the caption, defaults to empty.
 
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 677: Line 1,043:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_set_foo -->
+
<!-- Pod2Wiki=item_get_parent_id -->
−
===set_foo===
+
====get_parent_id====
  
−
  set =&gt; "foo"
+
  $eprintid = $doc-&gt;get_parent_id
−
The name of the set this document belongs to, defaults to none (preview won't be shown as part of a set).
+
Returns the ID of the parent for this document, (i.e. the eprint ID).
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 691: Line 1,057:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_add_relation -->
 
<!-- Pod2Wiki=item_add_relation -->
−
===add_relation===
+
====add_relation====
  
 
  $doc-&gt;add_relation( $tgt, @types )
 
  $doc-&gt;add_relation( $tgt, @types )
−
Add one or more relations to $doc pointing to $tgt (does not modify $tgt).
+
Add one or more relations with type(s) specified by <tt>@types</tt> to the  document data object and pointing to the <tt>$tgt</tt> data object. 
 +
 
 +
This will not update the <tt>$tgt</tt> data object even if reflexive relations exist.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 704: Line 1,072:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_remove_relation -->
 
<!-- Pod2Wiki=item_remove_relation -->
−
===remove_relation===
+
====remove_relation====
  
−
  $doc-&gt;remove_relation( $tgt [, @types ] )
+
  $doc-&gt;remove_relation( $tgt, [ @types ] )
−
Removes the relations in $doc to $tgt. If @types isn't given removes all relations to $tgt. If $tgt is undefined removes all relations given in @types.
+
Removes the relations for the document data object to the <tt>$tgt</tt> data  object. If <tt>@types</tt> is not defined, remove all relations to <tt>$tgt</tt>. If <tt>$tgt</tt> is also undefined removes all relations given in <tt>@types</tt>.
  
−
If you want to remove all relations do $doc-&gt;set_value( "relation", [] );
+
If both <tt>$tgt</tt>, and <tt>@types</tt> are both undefined no relations will be  removed. If you want to remove all relations do:
  
 +
$doc-&gt;set_value( "relation", [] );
 +
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 719: Line 1,089:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_has_relation -->
 
<!-- Pod2Wiki=item_has_relation -->
−
===has_relation===
+
====has_relation====
  
−
  $bool = $doc-&gt;has_relation( $tgt [, @types ] )
+
  $bool = $doc-&gt;has_relation( $tgt, [ @types ] )
−
Returns true if $doc has relations to $tgt. If @types is given checks that $doc satisfies all of the given types. $tgt may be undefined.
+
Returns <tt>true</tt> if document data object has relations to <tt>$tgt</tt>. If <tt>@types</tt> is also given, check these relations satisfy all of the given types. If <tt>$tgt</tt> is undefined, relations that satisfy the given types may be to any data object.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 732: Line 1,102:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_search_related -->
 
<!-- Pod2Wiki=item_search_related -->
−
===search_related===
+
====search_related====
  
 
  $list = $doc-&gt;search_related( [ $type ] )
 
  $list = $doc-&gt;search_related( [ $type ] )
−
Return a [[API:EPrints/List|EPrints::List]] that contains all documents related to this document. If $type is defined returns only those documents related by $type.
+
Returns an [[API:EPrints/List|EPrints::List]] that contains all document data objects  related to this document data object. If <tt>$type</tt> is defined return  only those document data object related by that type.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_render_citation_link -->
 +
====render_citation_link====
 +
 
 +
$citation = $doc-&gt;render_citation_link( $style, %params )
 +
Returns a XHTML DOM citation rendering of the document data object. Using citation <tt>$style</tt> and <tt>%params</tt> provided and setting class for DOM parent element to <tt>ep_document_link</tt>.
 +
 
 +
<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_render_video_preview -->
 +
====render_video_preview====
 +
 
 +
$frag = $doc-&gt;render_video_preview( $css_class )
 +
Returns a XHTML DOM fragment rendering of a HTML5 video preview with  optional subtitles.  Assigning the <tt>$css_class</tt> to the parent element  if the XHTML DOM fragment, if provided.
 +
 
 +
Access / security concerns should be addressed at a higher level.
 +
 
 +
<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_permit -->
 +
====permit====
 +
 
 +
$boolean = $doc-&gt;permit( $priv, $user )
 +
Returns boolean depending on whether the <tt>$user</tt> has the privilege  <tt>$priv</tt> to carry out a particular action on this document data  object.
 +
 
 +
See [[API:EPrints/DataObj#permit|EPrints::DataObj#permit]].
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_utility_methods -->
 +
===Utility Methods===
 +
<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_doc_with_eprintid_and_pos -->
 +
====doc_with_eprintid_and_pos====
 +
 
 +
EPrints::DataObj::doc_with_eprintid_and_pos( $repository, $eprintid, $pos )
 +
Find the document for an eprint based on the <tt>$eprintid</tt> and <tt>$pos</tt> values supplied matching the document's corresponding fields.
 +
 
 +
Returns the document data object matching the criteria. Otherwise, checks <tt>dark_document</tt> dataset if it exists to find a corresponding match.
 +
 
 +
<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_main_input_tags -->
 +
====main_input_tags====
 +
 
 +
EPrints::DataObj::Document::main_input_tags( $session, $object )
 +
<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_main_render_option -->
 +
====main_render_option====
 +
 
 +
EPrints::DataObj::main_render_option( $session, $object )
 +
<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_sanitise -->
 +
====sanitise====
 +
 
 +
$cleanfilename = EPrints::DataObj::Document::sanitise( $filename )
 +
Sanitises filename by replacing invalid characters. Mainly uses [[API:EPrints/System#sanitise|EPrints::System#sanitise]] but also replaces <tt>/</tt> with <tt>_</tt> to  ensure these do not get confused as a separator between direectories.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_see_also -->
 +
==SEE ALSO==
 +
[[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]], [[API:EPrints/DataObj|EPrints::DataObj]] and  [[API:EPrints/DataSet|EPrints::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%; '>
Line 746: Line 1,229:
 
<!-- Pod2Wiki=head_copyright -->
 
<!-- Pod2Wiki=head_copyright -->
 
==COPYRIGHT==
 
==COPYRIGHT==
 +
{{API:Copyright}}
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>

Latest revision as of 00:38, 3 January 2022

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


Contents

NAME

EPrints::DataObj::Document - A single format of a record.

User Comments


DESCRIPTION

Document represents a single format of an EPrint (eg. PDF) - the actual file(s) rather than the metadata.

Inherits from EPrints::DataObj::SubObject, which in turn inherits from EPrints::DataObj.

User Comments


INSTANCE VARIABLES

See EPrints::DataObj#INSTANCE_VARIABLES.

User Comments


CORE METADATA FIELDS

User Comments


docid (int)

The unique ID of the document.

User Comments


rev_number (int)

The revision number of this document record.

User Comments


pos (int)

The position of the document record within those associated with the eprint.

User Comments


placement (int)

Placement of the document - the order documents in which should be shown. This may be different to pos, as the ultimate_doc_pos may lead to a different ordering.

User Comments


format (namedset)

The format of this document. One of the types of the namedset c<document>.

User Comments


formatdesc (text)

An additional description of this document. For example the specific version of a format.

User Comments


language (namedset)

The ISO 639-1 code of the language of this document. The default configuration of EPrints does not set this.

User Comments


security (namedset)

The security type of this document - who can view it. One of the types of the namedset security.

User Comments


license (namedset)

The license applied of this document - who can view it. One of the types of the namedset license.

User Comments


main (text)

The file which we should link to. For something like a PDF file this is the only file. For an HTML document with images it would be the name of the actual HTML file.

User Comments


date_embargo (date)

The date until which the document has restricted access (set by security). At which point the embargo is lifted and security is set to public and this field set back to undef.

Requires bin/lift_embargos script to be deployed as a cron job.

User Comments


date_embargo_retained (date)

The retained date of any embargo originally placed on this document. This is updated when a user modifies date_embargo but is not unset by the bin/lift_embargos script.

User Comments


media (compound)

A compound field containing a description of the document media - dimensions, codec etc.

User Comments


REFERENCES AND RELATED OBJECTS

User Comments


eprintid (itemref)

The ID number of the eprint to which this document belongs.

User Comments


files (subobject, multiple)

A virtual field which represents the list of files which are part of this record.

User Comments


relation (relation, multiple)

Predicated relationships between this document and other data objects within the archive.

User Comments


METHODS

User Comments


Constructor Methods

User Comments


create

$doc = EPrints::DataObj::Document::create( $session, $eprint )

Create and return a new document belonging to the given $eprint object.

N.B. This creates the document in the database, not just in memory.

User Comments


create_from_data

$dataobj = EPrints::DataObj::Document::create_from_data( $session, $data, $dataset )

Create document data object from $data provided.

Returns undef if a bad (or no) eprintid specified in $data.

Otherwise calls the parent method in EPrints::DataObj.

User Comments


Class Methods

User Comments


get_system_field_info

$fields = EPrints::DataObj::Document->get_system_field_info

Returns an array describing the system metadata of the document dataset.

User Comments


get_defaults

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

Returns default values for this data object based on the starting $data.

User Comments


get_dataset_id

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

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

User Comments


get_parent_dataset_id

$dataset_id = EPrints::DataObj::Document->get_parent_dataset_id

Returns the ID of the parent dataset for a document, (i.e. eprint).

User Comments


Object Methods

User Comments


clone

$newdoc = $doc->clone( $eprint )

Attempt to clone this document. Both the document metadata and the actual files. The clone will be associated with the given $eprint.

Returns to the newly colument document.

User Comments


remove

$success = $doc->remove

Attempt to completely delete this document. Including derived documents such as thumbnails.

Returns boolean dependent on success of deleting document.

User Comments


get_eprint

$eprint = $doc->get_eprint

Returns the eprint this document is associated with.

Alias for: 

$doc->get_parent

User Comments


get_baseurl

$url = $doc->get_baseurl

Returns the base URL of the document.

User Comments


is_public

$boolean = $doc->is_public

Returnes true if this document has no security set and is in the live archive. Otherwise, returns false.

User Comments


path

$path = $doc->path

Returns the relative path to the document without specifying any file.

User Comments


file_path

$path = $doc->file_path( [ $file ] )

Returns the relative path to $file stored in this document. If $file is undefined returns the path to the main file.

This is an efficient shortcut to this: 

my $file = $doc->stored_file( $filename );
my $path = $file->path;

User Comments


get_url

$url = $doc->get_url( [ $file ] )

Returns the full URL of the document.

If $file is not specified then the main file is used.

User Comments


local_path

$path = $doc->local_path

DEPRECATED.

Returns the full path of the directory where this document is stored in the filesystem.

User Comments


files

%files = $doc->files

Returns a hash, the keys of which are all the files belonging to this document (relative to local_path). The values are the sizes of the files in bytes.

User Comments


remove_file

$success = $doc->remove_file( $filename )

Attempts to remove the file with $filename. $filename must be specified in the format that can be retrieved by get_stored_file.

User Comments


set_main

$doc->set_main( $main_file )

Sets main for the document to the named $main_file and adjusts format and mime_type as necessary. Will not affect the database until the document is committed.

Unsets main if $main_file is undefined.

User Comments


get_main

$filename = $doc->get_main

Returns the filename of the file set as main in this document.

User Comments


set_format

$doc->set_format( $format )

Set format for document to $format. Will not affect the database until document is committed.

Alias for: 

$doc->set_value( "format" , $format );

User Comments


set_format_desc

$doc->set_format_desc( $format_desc )

Set format description for document to $format_desc. Will not affect the database until document is committed.

Alias for: 

$doc->set_value( "format_desc" , $format_desc );

User Comments


upload

$success = $doc->upload( $filehandle, $filename, [ $preserve_path, $filesize ] )

DEPRECATED - Use add_file, which will automatically identify the file type.

Upload the contents of the given $filehandle into this document as the given $filename.

If $preserve_path then make any subdirectories needed, otherwise place this in the top level directory.

User Comments


add_file

$fileobj = $doc->add_file( $file, $filename, [ $preserve_path ] )

$file is the full path to a file to be added to the document, with name $filename. $filename is passed through EPrints::System#sanitise before being written.

If $preserve_path is true then include path components in $filename.

Returns the file object if successfully created or undef on failure.

User Comments


upload_archive

$success = $doc->upload_archive( $filehandle, $filename, $archive_format )

DEPRECATED - use add_archive.

Upload the file contents provided through $filehandle using the filename from $filename. How to deal with the specified $archive_format (e.g. .zip, .tar.gz) is configured in EPrints::SystemSettings.

User Comments


add_archive

$success = $doc->add_archive( $file, $archive_format )

Adds the contents of that archive $file to the document, where $archive_format is the format of the archive file (e.g. .zip, .tar.gz, etc.)

Returns a boolean dependent on whether the contents of the archive file is added to the document's subdirectory on the filesystem.

User Comments


add_directory

$success = $doc->add_directory( $directory )

Upload the contents of $directory to this document. This will not set the document's main field.

This method expects $directory to have a trailing slash /.

Returns boolean depending on success of adding directory to document.

User Comments


upload_url

$success = $doc->upload_url( $url )

Attempts to grab files from the given $url over HTTP. Grabbing files this way is always problematic. Therefore, by default, only relative links will be followed and only links to files in the same directory or subdirectory will be followed.

This method by default uses wget. However, you can modify this in EPrints::SystemSettings.

Returns a boolean dependent of whether file(s) were successfully uploaded.

User Comments


commit

$success = $doc->commit( [ $force ] )

Commit any changes that have been made to this data object to the database.

Calls set_document_automatic_fields in the archive's configuration first to set any automatic fields that may be needed.

If $force is defined and true then still commit even if there are no non-volatile changes.

Returns boolean depending on whether commit of document data object is successful.

User Comments


get_derived_versions

@derived_docs = $doc->get_derived_versions

Returns an array of documents that are derived from the current document through the isVersionOf relation.

User Comments


validate

$problems = $doc->validate( [ $for_archive ] )

Validates the document data object. If $for_archive is defined this will be passed through to the archive configured validate_document method, in case it is required for bespoke changes to this method.

Returns a reference to an array of XHTML DOM objects describing validation problems with the entire document, including the metadata and repository config specific requirements.

A returned reference to an empty array indicates no problems.

User Comments


user_can_view

$boolean = $doc->user_can_view( $user )

Returns true if this document's security settings allow the given $user access to view it.

User Comments


get_type

$type = $doc->get_type

Returns the type of this document.

Alias for: 

$doc->value( "format" );

User Comments


queue_files_modified

$doc->queue_files_modified

Adds a files_modified task (e.g. for creating/updating thumbnails) to the event queue.

User Comments


files_modified

$doc->files_modified

This method does all the things that need doing when a file has been modified.

User Comments


rehash

$doc->rehash

Recalculate the hash value of the document. Uses MD5 of the files (in alphabetic order), but can use user-specified hashing function instead.

User Comments


make_indexcodes

$indexcodes_doc = $doc->make_indexcodes

Make the index codes document for this document. Returns the generated index codes document on success or undef on failure.

User Comments


remove_indexcodes

$doc = $doc->remove_indexcodes

Remove any documents containing index codes for this document. Returns the number of documents removed.

User Comments


cache_file

$filename = $doc->cache_file( $suffix );

DEPRECATED

Returns a cache filename for this document with the given $suffix.

User Comments


register_parent

$doc->register_parent( $parent )

Registers the $parent EPrints::DataObj::EPrint object for this document.

This may cause reference loops, but it does avoid two identical eprint data objects existing at once.

User Comments


thumbnail_url

$doc->thumbnail_url( $size )

Returns the URL for the thumbnail of the document for a specified $size. If $size is unspecified defaults to small. Other values for $size include medium and preview.

Returns undef if file for particular type of thumbnail does not exist.

This method is called bt icon_url. It is best to use that method to reliably retrieve the required URL.

User Comments


icon_url

$doc->icon_url( $size )

Returns the URL for the icon of the document for a specified $size. If $size is unspecified defaults to small. Other values for $size include medium and preview.

User Comments


render_icon_link

$frag = $doc->render_icon_link( %opts )

Render a link to the icon for this document.

Options: 

new_window => 1 - Make link go to _blank not current window.
 
preview => 1 - If possible, provide a preview pop-up.
 
public => 0 - Show thumbnail/preview only on public documents.
 
public => 1 - Show thumbnail/preview on all documents if possible.
 
with_link => 0 - Do not link.

User Comments


render_preview_link

$frag = $doc->render_preview_link( %opts )

Render a link to the preview for this document (if available) using a lightbox.

Options:

User Comments


caption_frag

caption => $frag

XHTML fragment to use as the caption, defaults to empty.

User Comments


set_name

set => "name"

The name of the set this document belongs to, defaults to none (preview won't be shown as part of a set).

User Comments


thumbnail_plugin

$plugin = $doc->thumbnail_plugin( $size )

Returns the plugin used to generatee thumbnails of the specified $size.

User Comments


thumbnail_path

$path = $doc->thumbnail_path

DEPRECATED

Returns the filesystem path to location of thumbnails for the document.

User Comments


thumbnail_types

$doc->thumbnail_types

Returns array containing names of all the thumbnail types available for this document.

User Comments


remove_thumbnails

$doc->remove_thumbnails

Removes all thumbnail files associated with this document.

User Comments


make_thumbnails

$doc->make_thumbnails

Make all the thumbnail files required for this document.

User Comments


mime_type

$mime_type = $doc->mime_type

DEPRECATED - use $doc->value( "mime_type" )

Returns the MIME type of this document.

User Comments


get_parent_id

$eprintid = $doc->get_parent_id

Returns the ID of the parent for this document, (i.e. the eprint ID).

User Comments


add_relation

$doc->add_relation( $tgt, @types )

Add one or more relations with type(s) specified by @types to the document data object and pointing to the $tgt data object.

This will not update the $tgt data object even if reflexive relations exist.

User Comments


remove_relation

$doc->remove_relation( $tgt, [ @types ] )

Removes the relations for the document data object to the $tgt data object. If @types is not defined, remove all relations to $tgt. If $tgt is also undefined removes all relations given in @types.

If both $tgt, and @types are both undefined no relations will be removed. If you want to remove all relations do: 

$doc->set_value( "relation", [] );

User Comments


has_relation

$bool = $doc->has_relation( $tgt, [ @types ] )

Returns true if document data object has relations to $tgt. If @types is also given, check these relations satisfy all of the given types. If $tgt is undefined, relations that satisfy the given types may be to any data object.

User Comments


search_related

$list = $doc->search_related( [ $type ] )

Returns an EPrints::List that contains all document data objects related to this document data object. If $type is defined return only those document data object related by that type.

User Comments


render_citation_link

$citation = $doc->render_citation_link( $style, %params )

Returns a XHTML DOM citation rendering of the document data object. Using citation $style and %params provided and setting class for DOM parent element to ep_document_link.

User Comments


render_video_preview

$frag = $doc->render_video_preview( $css_class )

Returns a XHTML DOM fragment rendering of a HTML5 video preview with optional subtitles. Assigning the $css_class to the parent element if the XHTML DOM fragment, if provided.

Access / security concerns should be addressed at a higher level.

User Comments


permit

$boolean = $doc->permit( $priv, $user )

Returns boolean depending on whether the $user has the privilege $priv to carry out a particular action on this document data object.

See EPrints::DataObj#permit.

User Comments


Utility Methods

User Comments


doc_with_eprintid_and_pos

EPrints::DataObj::doc_with_eprintid_and_pos( $repository, $eprintid, $pos )

Find the document for an eprint based on the $eprintid and $pos values supplied matching the document's corresponding fields.

Returns the document data object matching the criteria. Otherwise, checks dark_document dataset if it exists to find a corresponding match.

User Comments


main_input_tags

EPrints::DataObj::Document::main_input_tags( $session, $object )

User Comments


main_render_option

EPrints::DataObj::main_render_option( $session, $object )

User Comments


sanitise

$cleanfilename = EPrints::DataObj::Document::sanitise( $filename )

Sanitises filename by replacing invalid characters. Mainly uses EPrints::System#sanitise but also replaces / with _ to ensure these do not get confused as a separator between direectories.

User Comments


SEE ALSO

EPrints::DataObj::SubObject, EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

© Copyright 2000-2024 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 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 3.4. If not, see http://www.gnu.org/licenses/.

User Comments


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