API:EPrints/DataObj/Document - Revision history

Pod2wiki at 00:38, 3 January 2022

2022-01-03T00:38:05Z

Show changes

Pod2wiki at 00:34, 3 January 2022

2022-01-03T00:34:47Z

Pod2wiki at 00:04, 3 January 2022

2022-01-03T00:04:19Z

Show changes

Pod2wiki at 17:11, 29 December 2021

2021-12-29T17:11:46Z

Pod2wiki at 20:47, 28 December 2021

2021-12-28T20:47:30Z

Pod2wiki at 10:30, 28 December 2021

2021-12-28T10:30:04Z

Show changes

Pod2wiki at 10:27, 28 December 2021

2021-12-28T10:27:42Z

Pod2wiki at 10:25, 28 December 2021

2021-12-28T10:25:27Z

Show changes

Tdb01r at 09:57, 22 January 2013

2013-01-22T09:57:13Z

Show changes

Tdb01r at 15:26, 16 December 2011

2011-12-16T15:26:26Z

@@ Line 1,422: / Line 1,422: @@
 ====sanitise====
-  $cleanfilename = EPrints::DataObj::Document sanitise( $filename )
+  $cleanfilename = EPrints::DataObj::Document::sanitise( $filename )
-DEPRECATED - Use [[API:EPrints/System#sanitise|EPrints::System#sanitise]].
+Sanitises filename by replacing invalid characters. Mainly uses
+ [[API:EPrints/System#sanitise|EPrints::System#sanitise]] but also replaces <tt>/</tt> with <tt>_</tt> to
-Sanitises filename by replacing invalid characters.
+ 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%; '>

@@ Line 250: / Line 250: @@
 ===get_system_field_info===
-  $metadata = EPrints::DataObj::Document-&gt;get_system_field_info
+  $fields = EPrints::DataObj::Document-&gt;get_system_field_info
 Returns an array describing the system metadata of the document  dataset.
@@ Line 346: / Line 346: @@
   $defaults = EPrints::DataObj::Document-&gt;get_defaults( $class, $session, $data, $dataset )
-Return default values for this data object based on the starting  <tt>$data</tt>.
+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%; '>
@@ Line 389: / Line 389: @@
   $eprint = $doc-&gt;get_eprint
-Return the eprint this document is associated with.
+Returns the eprint this document is associated with.
 Alias for:
@@ Line 493: / Line 493: @@
   %files = $doc-&gt;files
-Return 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.
+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%; '>
@@ Line 534: / Line 534: @@
   $filename = $doc-&gt;get_main
-Return the filename of the file set as <tt>main</tt> 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%; '>
@@ Line 713: / Line 713: @@
   @derived_docs = $doc-&gt;get_derived_versions
-Return an array of documents that are derived from the current document through the <tt>isVersionOf</tt> relation.
+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%; '>
@@ Line 743: / Line 743: @@
   $boolean = $doc-&gt;user_can_view( $user )
-Return <tt>true</tt> if this document's security settings allow the given  <tt>$user</tt> access to view it.
+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%; '>
@@ Line 964: / Line 964: @@
   $plugin = $doc-&gt;thumbnail_plugin( $size )
-Return the plugin used to generatee thumbnails of the specified  <tt>$size</tt>.
+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%; '>

@@ Line 51: / Line 51: @@
 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%; '>
@@ Line 205: / Line 181: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_relation -->
+<!-- Pod2Wiki=item_media -->
-===relation (relation, multiple)===
+===media (compound)===
-Predicated relationships between this document and other data objects  within the archive.
+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%; '>
@@ Line 217: / Line 226: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_media -->
+<!-- Pod2Wiki=item_relation -->
-===media (compound)===
+===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%; '>
@@ Line 336: / Line 345: @@
 ===get_defaults===
-  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $session, $data )
+  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $class, $session, $data, $dataset )
 Return default values for this data object based on the starting  <tt>$data</tt>.

@@ Line 891: / Line 891: @@
 Render a link to the icon for this document.
-Options:
+<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>
@@ Line 901: / Line 908: @@
 </div>
 <!-- Pod2Wiki=item_new_window_1 -->
-===new_window_1===
+====new_window_1====
   new_window =&gt; 1
@@ Line 914: / Line 921: @@
 </div>
 <!-- Pod2Wiki=item_preview_1 -->
-===preview_1===
+====preview_1====
   preview =&gt; 1
@@ Line 927: / Line 934: @@
 </div>
 <!-- Pod2Wiki=item_public_0 -->
-===public_0===
+====public_0====
   public =&gt; 0
@@ Line 940: / Line 947: @@
 </div>
 <!-- Pod2Wiki=item_public_1 -->
-===public_1===
+====public_1====
   public =&gt; 1
@@ Line 953: / Line 960: @@
 </div>
 <!-- Pod2Wiki=item_with_link_0 -->
-===with_link_0===
+====with_link_0====
   with_link =&gt; 0
@@ Line 966: / Line 973: @@
 </div>
 <!-- Pod2Wiki=item_render_preview_link -->
-===render_preview_link===
+====render_preview_link====
   $frag = $doc-&gt;render_preview_link( %opts )
@@ Line 981: / Line 988: @@
 </div>
 <!-- Pod2Wiki=item_caption_frag -->
-===caption_frag===
+====caption_frag====
   caption =&gt; $frag
@@ Line 994: / Line 1,001: @@
 </div>
 <!-- Pod2Wiki=item_set_name -->
-===set_name===
+====set_name====
   set =&gt; "name"
@@ Line 1,007: / Line 1,014: @@
 </div>
 <!-- Pod2Wiki=item_thumbnail_plugin -->
-===thumbnail_plugin===
+====thumbnail_plugin====
   $plugin = $doc-&gt;thumbnail_plugin( $size )
@@ Line 1,020: / Line 1,027: @@
 </div>
 <!-- Pod2Wiki=item_thumbnail_path -->
-===thumbnail_path===
+====thumbnail_path====
   $path = $doc-&gt;thumbnail_path
@@ Line 1,035: / Line 1,042: @@
 </div>
 <!-- Pod2Wiki=item_thumbnail_types -->
-===thumbnail_types===
+====thumbnail_types====
   $doc-&gt;thumbnail_types
@@ Line 1,048: / Line 1,055: @@
 </div>
 <!-- Pod2Wiki=item_remove_thumbnails -->
-===remove_thumbnails===
+====remove_thumbnails====
   $doc-&gt;remove_thumbnails
@@ Line 1,061: / Line 1,068: @@
 </div>
 <!-- Pod2Wiki=item_make_thumbnails -->
-===make_thumbnails===
+====make_thumbnails====
   $doc-&gt;make_thumbnails
@@ Line 1,074: / Line 1,081: @@
 </div>
 <!-- Pod2Wiki=item_mime_type -->
-===mime_type===
+====mime_type====
   $mime_type = $doc-&gt;mime_type
@@ Line 1,089: / Line 1,096: @@
 </div>
 <!-- Pod2Wiki=item_get_parent_dataset_id -->
-===get_parent_dataset_id===
+====get_parent_dataset_id====
   $dataset_id = EPrints::DataObj::Document-&gt;get_parent_dataset_id
@@ Line 1,102: / Line 1,109: @@
 </div>
 <!-- Pod2Wiki=item_get_parent_id -->
-===get_parent_id===
+====get_parent_id====
   $eprintid = $doc-&gt;get_parent_id
@@ Line 1,115: / Line 1,122: @@
 </div>
 <!-- Pod2Wiki=item_add_relation -->
-===add_relation===
+====add_relation====
   $doc-&gt;add_relation( $tgt, @types )
@@ Line 1,130: / Line 1,137: @@
 </div>
 <!-- Pod2Wiki=item_remove_relation -->
-===remove_relation===
+====remove_relation====
   $doc-&gt;remove_relation( $tgt, [ @types ] )
@@ Line 1,147: / Line 1,154: @@
 </div>
 <!-- Pod2Wiki=item_has_relation -->
-===has_relation===
+====has_relation====
   $bool = $doc-&gt;has_relation( $tgt, [ @types ] )
@@ Line 1,160: / Line 1,167: @@
 </div>
 <!-- Pod2Wiki=item_search_related -->
-===search_related===
+====search_related====
   $list = $doc-&gt;search_related( [ $type ] )
@@ Line 1,173: / Line 1,180: @@
 </div>
 <!-- Pod2Wiki=item_render_citation_link -->
-===render_citation_link===
+====render_citation_link====
   $citation = $doc-&gt;render_citation_link( $style, %params )
@@ Line 1,186: / Line 1,193: @@
 </div>
 <!-- Pod2Wiki=item_render_video_preview -->
-===render_video_preview===
+====render_video_preview====
   $frag = $doc-&gt;render_video_preview( $css_class )
@@ Line 1,201: / Line 1,208: @@
 </div>
 <!-- Pod2Wiki=item_permit -->
-===permit===
+====permit====
   $boolean = $doc-&gt;permit( $priv, $user )

@@ Line 1: / Line 1: @@
 <!-- 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.
-  -->{{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=perl_lib/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 -->