API:EPrints/DataObj/File - Revision history

Pod2wiki at 10:51, 10 January 2022

2022-01-10T10:51:18Z

2021-12-29T17:11:38Z

2021-12-29T17:06:41Z

2013-07-25T13:36:02Z

2013-07-25T13:34:28Z

2013-01-22T09:57:17Z

2011-12-16T15:26:31Z

2011-12-01T12:27:58Z

2011-08-25T10:47:00Z

2010-06-17T13:05:59Z

@@ Line 163: / Line 163: @@
 Virtual field for storing the file's content.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 235: / Line 257: @@
   $fields = EPrints::DataObj::File-&gt;get_system_field_info
-Returns an array describing the system metadata of the document dataset.
+Returns an array describing the system metadata fields of the file  dataset.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 248: / Line 270: @@
   $dataset = EPrints::DataObj::File-&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%; '>

@@ Line 234: / Line 234: @@
 ====get_system_field_info====
-  $thing = EPrints::DataObj::File-&gt;get_system_field_info
+  $fields = EPrints::DataObj::File-&gt;get_system_field_info
 Returns an array describing the system metadata of the document dataset.
@@ Line 374: / Line 374: @@
 ====write_copy====
-  $success = $stored-&gt;write_copy( $filename )
+  $success = $file-&gt;write_copy( $filename )
 Write a copy of this file to <tt>$filename</tt>.
@@ Line 389: / Line 389: @@
 ====write_copy_fh====
-  $success = $stored-&gt;write_copy_fh( $filehandle )
+  $success = $file-&gt;write_copy_fh( $filehandle )
 Write a copy of this file to <tt>$filehandle</tt>.
@@ Line 471: / Line 471: @@
 ====add_plugin_copy====
-  $stored-&gt;add_plugin_copy( $plugin, $sourceid )
+  $file-&gt;add_plugin_copy( $plugin, $sourceid )
 Add a copy of this file stored using <tt>$plugin</tt> identified by  <tt>$sourceid</tt>.
@@ Line 484: / Line 484: @@
 ====remove_plugin_copy====
-  $stored-&gt;remove_plugin_copy( $plugin )
+  $file-&gt;remove_plugin_copy( $plugin )
 Remove the copy of this file stored using <tt>$plugin</tt>.
@@ Line 497: / Line 497: @@
 ====get_file====
-  $success = $stored-&gt;get_file( $f, [ $offset, $n ] )
+  $success = $file-&gt;get_file( $f, [ $offset, $n ] )
 Get the contents of the stored file.

@@ Line 6: / Line 6: @@
 <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
-'''EPrints::DataObj::File''' - a stored file
+EPrints::DataObj::File - a stored file
 <!-- Edit below this comment -->
@@ Line 192: / Line 192: @@
 : CALLBACK is:
-<pre>  sub {
+<source lang="perl">sub {
-    my( $buffer ) = @_;
+	my( $buffer ) = @_;
-    ...
-    return 1;
+	print $buffer;
-  }</pre>
 * $content_length = $stored-&gt;set_file( CONTENT, $content_length )
@@ Line 203: / Line 207: @@
 : Returns $content_length or undef on failure.
-: CONTENT may be one of:
+: If CONTENT has fewer bytes than $content_length the result is undetermined and a warning will be printed.
 ** CODEREF
 :: Will be called until it returns empty string ("").
 ** SCALARREF
@@ Line 212: / Line 223: @@
 ** GLOB
-:: Will be treated as a file handle and read with sysread().
+:: Will be treated as a file handle and read with sysread() until the eof.
 * $content_length = $file-&gt;set_file_chunk( CONTENT, $content_length, $offset, $total )
@@ Line 227: / Line 238: @@
 <!-- Pod2Wiki=head_see_also -->
 ==SEE ALSO==
 : [[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
@@ Line 235: / Line 248: @@
 <!-- Pod2Wiki=head_copyright -->
 ==COPYRIGHT==
-: Copyright 2000-2011 University of Southampton.
+: Copyright 2000-2013 University of Southampton.
 : This file is part of EPrints http://www.eprints.org/.

@@ 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/File.pm|package_name=EPrints::DataObj::File}}[[Category:API|FILE]][[Category:API:EPrints/DataObj|FILE]][[Category:API:EPrints/DataObj/File|FILE]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/DataObj/File.pm|package_name=EPrints::DataObj::File}}[[Category:API|FILE]][[Category:API:EPrints/DataObj|FILE]][[Category:API:EPrints/DataObj/File|FILE]]<div><!-- Edit below this comment -->

@@ Line 220: / Line 220: @@
   $dataobj = EPrints::DataObj::File-&gt;create_from_data( $session, $data [, $dataset ] )
-Create a new File record using $data. If "_content" is defined in $data it will be read from and stored - for possible values see set_file().
+Create a new File record using $data.
 <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 256: / Line 261: @@
   $dataset = EPrints::DataObj::File-&gt;get_dataset_id
 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%; '>

@@ Line 444: / Line 444: @@
 ====get_file====
-  $success = $stored-&gt;get_file( CALLBACK )
+  $success = $stored-&gt;get_file( CALLBACK [, $offset, $n ] )
-Get the contents of the stored file - see [[API:EPrints/Storage|EPrints::Storage]]::retrieve().
+Get the contents of the stored file - see [[API:EPrints/Storage#retrieve|EPrints::Storage/retrieve]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>