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

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
−
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
+
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
−
  -->{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Document.pm|package_name=EPrints::DataObj::Document}}[[Category:API|Document]]<!-- End of Pod2Wiki -->
+
  -->{{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 -->
−
<!-- Pod2Wiki=head_name -->=NAME=
+
 
 +
 
 +
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 +
==NAME==
 
'''EPrints::DataObj::Document''' - A single format of a record.
 
'''EPrints::DataObj::Document''' - A single format of a record.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
+
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 
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:  
 
This class is a subclass of DataObj, with the following metadata fields:  
  
−
<!-- End of Pod2Wiki -->
+
* docid (text)
−
<!-- Pod2Wiki=item_docid -->==docid==
+
: 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.
  
−
  docid (text)
+
: This should probably have been and "int" but isn't. I later version of EPrints may change this.
  
−
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.
+
* eprintid (itemref)
 +
: The id number of the eprint to which this document belongs.
  
−
This should probably have been and "int" but isn't. I later version of EPrints may change this.
+
* placement (int)
 +
: Placement of the document - the order documents should be shown in.
  
−
<!-- End of Pod2Wiki -->
+
* format (namedset)
−
<!-- Pod2Wiki=item_eprintid -->==eprintid==
+
: The format of this document. One of the types of the dataset "document".
  
−
  eprintid (itemref)
+
* formatdesc (text)
 +
: An additional description of this document. For example the specific version of a format.
  
−
The id number of the eprint to which this document belongs.
+
* language (namedset)
 +
: The ISO ID of the language of this document. The default configuration of EPrints does not set this.
  
−
<!-- End of Pod2Wiki -->
+
* security (namedset)
−
<!-- Pod2Wiki=item_format -->==format==
+
: The security type of this document - who can view it. One of the types of the dataset "security".
  
−
  format (namedset)
+
* 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.
  
−
The format of this document. One of the types of the dataset "document".
+
* files (subobject, multiple)
 +
: A virtual field which represents the list of Files which are part of this record.
  
−
<!-- End of Pod2Wiki -->
+
* media
−
<!-- Pod2Wiki=item_formatdesc -->==formatdesc==
+
: A compound field containing a description of the document media - dimensions, codec etc.
  
−
  formatdesc (text)
+
<!-- Edit below this comment -->
  
−
An additional description of this document. For example the specific version of a format.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_language -->==language==
+
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 +
<!-- Pod2Wiki=head_get_system_field_info -->
 +
===get_system_field_info===
  
−
  language (namedset)
+
<source lang="perl">$metadata = EPrints::DataObj::Document->get_system_field_info
  
−
The ISO ID of the language of this document. The default configuration of EPrints does not set this.
+
</source>
 +
Return an array describing the system metadata of the Document dataset.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_security -->==security==
 
  
−
  security (namedset)
 
  
−
The security type of this document - who can view it. One of the types of the dataset "security".
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_dataset_id -->
 +
===get_dataset_id===
  
−
<!-- End of Pod2Wiki -->
+
<source lang="perl">$dataset = EPrints::DataObj::Document->get_dataset_id
−
<!-- Pod2Wiki=item_main -->==main==
 
  
−
  main (text)
+
</source>
 +
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
  
−
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.
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_documents -->==documents==
 
  
−
  documents (subobject, multiple)
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_defaults -->
 +
===get_defaults===
  
−
A virtual field which represents the list of Documents which are part of this record.
+
<source lang="perl">$defaults = EPrints::DataObj::Document->get_defaults( $session, $data )
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==
+
Return default values for this object based on the starting data.
  
−
  $metadata = EPrints::DataObj::Document-&gt;get_system_field_info
+
<!-- Edit below this comment -->
  
−
Return an array describing the system metadata of the Document dataset.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_new -->==new==
+
<!-- Pod2Wiki=head_clone -->
 +
===clone===
  
−
  $thing = EPrints::DataObj::Document-&gt;new( $session, $docid )
+
<source lang="perl">$newdoc = $doc->clone( $eprint )
  
−
Return the document with the given $docid, or undef if it does not exist.
+
</source>
 +
Attempt to clone this document. Both the document metadata and the actual files. The clone will be associated with the given EPrint.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_new_from_data -->==new_from_data==
 
  
−
  $doc = EPrints::DataObj::Document-&gt;new_from_data( $session, $data )
 
  
−
Construct a new EPrints::DataObj::Document based on the ref to a hash of metadata.
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_remove -->
 +
===remove===
  
−
<!-- End of Pod2Wiki -->
+
<source lang="perl">$success = $doc->remove
−
<!-- Pod2Wiki=item_get_defaults -->==get_defaults==
 
  
−
  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $session, $data )
+
</source>
 +
Attempt to completely delete this document
  
−
Return default values for this object based on the starting data.
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_clone -->==clone==
 
  
−
  $newdoc = $doc-&gt;clone( $eprint )
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_eprint -->
 +
===get_eprint===
  
−
Attempt to clone this document. Both the document metadata and the actual files. The clone will be associated with the given EPrint.
+
<source lang="perl">$eprint = $doc->get_eprint
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_remove -->==remove==
+
Return the EPrint this document is associated with.
  
−
  $success = $doc-&gt;remove
+
This is a synonym for get_parent().
  
−
Attempt to completely delete this document
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_get_eprint -->==get_eprint==
 
  
−
  $eprint = $doc-&gt;get_eprint
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_baseurl -->
 +
===get_baseurl===
  
−
Return the EPrint this document is associated with.
+
<source lang="perl">$url = $doc->get_baseurl( [$staff] )
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_get_baseurl -->==get_baseurl==
+
Return the base URL of the document. Overrides the stub in DataObj. $staff is currently ignored.
  
−
  $url = $doc-&gt;get_baseurl( [$staff] )
+
<!-- Edit below this comment -->
  
−
Return the base URL of the document. Overrides the stub in DataObj. $staff is currently ignored.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_is_public -->==is_public==
+
<!-- Pod2Wiki=head_is_public -->
 +
===is_public===
  
−
  $boolean = $doc-&gt;is_public()
+
<source lang="perl">$boolean = $doc->is_public()
  
 +
</source>
 
True if this document has no security set and is in the live archive.
 
True if this document has no security set and is in the live archive.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_get_url -->==get_url==
+
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_path -->
 +
===path===
 +
 
 +
<source lang="perl">$path = $doc->path
 +
 
 +
</source>
 +
Returns the relative path to the document WITHOUT any file.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_file_path -->
 +
===file_path===
 +
 
 +
<source lang="perl">$path = $doc->file_path( [ $filename ] )
 +
 
 +
</source>
 +
Returns the relative path to $filename stored in this document. If $filename is undefined returns the path to the main file.
  
−
  $url = $doc-&gt;get_url( [$file] )
+
This is an efficient shortcut to this:
  
 +
<pre>  my $file = $doc-&gt;stored_file( $filename );
 +
  my $path = $file-&gt;path;</pre>
 +
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_url -->
 +
===get_url===
 +
 +
<source lang="perl">$url = $doc->get_url( [$file] )
 +
 +
</source>
 
Return the full URL of the document. Overrides the stub in DataObj.
 
Return the full URL of the document. Overrides the stub in DataObj.
  
 
If file is not specified then the "main" file is used.
 
If file is not specified then the "main" file is used.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_local_path -->==local_path==
 
  
−
  $path = $doc-&gt;local_path
 
  
−
Return the full path of the directory where this document is stored in the filesystem.
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_files -->
 +
===files===
  
−
<!-- End of Pod2Wiki -->
+
<source lang="perl">%files = $doc->files
−
<!-- Pod2Wiki=item_files -->==files==
 
  
−
  %files = $doc-&gt;files
+
</source>
 +
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.
 +
 
 +
<!-- Edit below this comment -->
  
−
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.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_remove_file -->==remove_file==
+
<!-- Pod2Wiki=head_remove_file -->
 +
===remove_file===
  
−
  $success = $doc-&gt;remove_file( $filename )
+
<source lang="perl">$success = $doc->remove_file( $filename )
  
 +
</source>
 
Attempt to remove the given file. Give the filename as it is returned by get_files().
 
Attempt to remove the given file. Give the filename as it is returned by get_files().
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_remove_all_files -->==remove_all_files==
 
  
−
  $success = $doc-&gt;remove_all_files
 
  
−
Attempt to remove all files associated with this document.
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_set_main -->
 +
===set_main===
  
−
<!-- End of Pod2Wiki -->
+
<source lang="perl">$doc->set_main( $main_file )
−
<!-- Pod2Wiki=item_set_main -->==set_main==
 
  
−
  $doc-&gt;set_main( $main_file )
+
</source>
 +
Sets the main file and adjusts format and mime type as necessary. Won't affect the database until a $doc-&gt;commit().
  
−
Sets the main file. Won't affect the database until a $doc-&gt;commit().
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_get_main -->==get_main==
 
  
−
  $filename = $doc-&gt;get_main
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_main -->
 +
===get_main===
  
 +
<source lang="perl">$filename = $doc->get_main
 +
 +
</source>
 
Return the name of the main file in this document.
 
Return the name of the main file in this document.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_set_format -->==set_format==
 
  
−
  $doc-&gt;set_format( $format )
 
  
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_set_format -->
 +
===set_format===
 +
 +
<source lang="perl">$doc->set_format( $format )
 +
 +
</source>
 
Set format. Won't affect the database until a commit(). Just an alias  for $doc-&gt;set_value( "format" , $format );
 
Set format. Won't affect the database until a commit(). Just an alias  for $doc-&gt;set_value( "format" , $format );
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_set_format_desc -->==set_format_desc==
+
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_set_format_desc -->
 +
===set_format_desc===
  
−
  $doc-&gt;set_format_desc( $format_desc )
+
<source lang="perl">$doc->set_format_desc( $format_desc )
  
 +
</source>
 
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 the format description.  Won't affect the database until a commit(). Just an alias for $doc-&gt;set_value( "format_desc" , $format_desc );
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_upload -->==upload==
 
  
−
  $success = $doc-&gt;upload( $filehandle, $filename, [$preserve_path] )
 
  
−
Upload the contents of the given file handle into this document as the given filename.
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_add_file -->
 +
===add_file===
  
−
if $preserve_path then make any subdirectories needed, otherwise place this in the top level.
+
<source lang="perl">$fileobj = $doc->add_file( $file, $filename [, $preserve_path] )
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_add_file -->==add_file==
+
$file is the full path to a file to be added to the document, with name $filename. $filename is passed through [[API:EPrints/System#sanitise|EPrints::System/sanitise]] before being written.
  
−
  $success = $doc-&gt;add_file( $file, $filename, [$preserve_path] )
+
If $preserve_path is true then include path components in $filename.
  
−
$file is the full path to a file to be added to the document, with name $filename.
+
Returns the $fileobj created or undef on failure.
  
−
If $preserve_path then keep the filename as is (including subdirs and spaces)
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_sanitise -->==sanitise==
 
  
−
  $cleanfilename = sanitise( $filename )
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_add_archive -->
 +
===add_archive===
  
−
Return just the filename (no leading path) and convert any naughty characters to underscore.
+
<source lang="perl">$success = $doc->add_archive( $file, $archive_format )
 +
 
 +
</source>
 +
$file is the full path to an archive file, eg. zip or .tar.gz
 +
 
 +
This function will add the contents of that archive to the document.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_upload_archive -->==upload_archive==
 
  
−
  $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.
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_add_directory -->
 +
===add_directory===
  
−
(In case the over-loading of the word "archive" is getting confusing,  in this context we mean ".zip" or ".tar.gz" archive.)
+
<source lang="perl">$success = $doc->add_directory( $directory )
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_add_archive -->==add_archive==
+
Upload the contents of $directory to this document. This will not set the main file.
  
−
  $success = $doc-&gt;add_archive( $file, $archive_format )
+
This method expects $directory to have a trailing slash (/).
  
−
$file is the full path to an archive file, eg. zip or .tar.gz
+
<!-- Edit below this comment -->
  
−
This function will add the contents of that archive to the document.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_upload_url -->==upload_url==
+
<!-- Pod2Wiki=head_upload_url -->
 +
===upload_url===
  
−
  $success = $doc-&gt;upload_url( $url )
+
<source lang="perl">$success = $doc->upload_url( $url )
  
 +
</source>
 
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.
 
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.
  
 
This (by default) uses wget. The details can be configured in SystemSettings.
 
This (by default) uses wget. The details can be configured in SystemSettings.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_commit -->==commit==
+
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_commit -->
 +
===commit===
  
−
  $success = $doc-&gt;commit
+
<source lang="perl">$success = $doc->commit
  
 +
</source>
 
Commit any changes that have been made to this object to the database.
 
Commit any changes that have been made to this object to the database.
  
 
Calls "set_document_automatic_fields" in the ArchiveConfig first to set any automatic fields that may be needed.
 
Calls "set_document_automatic_fields" in the ArchiveConfig first to set any automatic fields that may be needed.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_validate -->==validate==
 
  
−
  $problems = $doc-&gt;validate( [$for_archive] )
 
  
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_validate -->
 +
===validate===
 +
 +
<source lang="perl">$problems = $doc->validate( [$for_archive] )
 +
 +
</source>
 
Return 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 reference to an empty array indicates no problems.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_get_type -->==get_type==
 
  
−
  $type = $doc-&gt;get_type
 
  
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_get_type -->
 +
===get_type===
 +
 +
<source lang="perl">$type = $doc->get_type
 +
 +
</source>
 
Return the type of this document.
 
Return the type of this document.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_files_modified -->==files_modified==
 
  
−
  $doc-&gt;files_modified
 
  
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_files_modified -->
 +
===files_modified===
 +
 +
<source lang="perl">$doc->files_modified
 +
 +
</source>
 
This method does all the things that need doing when a file has been modified.
 
This method does all the things that need doing when a file has been modified.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_rehash -->==rehash==
 
  
−
  $doc-&gt;rehash
 
  
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_rehash -->
 +
===rehash===
 +
 +
<source lang="perl">$doc->rehash
 +
 +
</source>
 
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.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_get_text -->==get_text==
+
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_make_indexcodes -->
 +
===make_indexcodes===
 +
 
 +
<source lang="perl">$doc = $doc->make_indexcodes()
 +
 
 +
</source>
 +
Make the indexcodes document for this document. Returns the generated document or undef on failure.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_remove_indexcodes -->
 +
===remove_indexcodes===
 +
 
 +
<source lang="perl">$doc = $doc->remove_indexcodes()
 +
 
 +
</source>
 +
Remove any documents containing index codes for this document. Returns the number of documents removed.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_render_icon_link -->
 +
===render_icon_link===
 +
 
 +
<source lang="perl">$frag = $doc->render_icon_link( %opts )
 +
 
 +
</source>
 +
Render a link to the icon for this document.
 +
 
 +
Options:
 +
 
 +
* new_window =&gt; 1
 +
: Make link go to _blank not current window.
 +
 
 +
* preview =&gt; 1
 +
: If possible, provide a preview pop-up.
 +
 
 +
* public =&gt; 0
 +
: Show thumbnail/preview only on public docs.
 +
 
 +
* public =&gt; 1
 +
: Show thumbnail/preview on all docs if poss.
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_render_preview_link -->
 +
===render_preview_link===
 +
 
 +
<source lang="perl">$frag = $doc->render_preview_link( %opts )
 +
 
 +
</source>
 +
Render a link to the preview for this document (if available) using a lightbox.
 +
 
 +
Options:
 +
 
 +
* caption =&gt; $frag
 +
: XHTML fragment to use as the caption, defaults to empty.
 +
 
 +
* set =&gt; "foo"
 +
: The name of the set this document belongs to, defaults to none (preview won't be shown as part of a set).
 +
 
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_add_relation -->
 +
===add_relation===
  
−
  $text = $doc-&gt;get_text
+
<source lang="perl">$doc->add_relation( $tgt, @types )
  
−
Get the text of the document as a UTF-8 encoded string, if possible.
+
</source>
 +
Add one or more relations to $doc pointing to $tgt (does not modify $tgt).
  
−
This is used for full-text indexing. The text will probably not be well formated.
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_words_file -->==words_file==
 
  
−
  $filename = $doc-&gt;words_file
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_remove_relation -->
 +
===remove_relation===
  
−
Return the filename in which this document uses to cache words  extracted from the full text.
+
<source lang="perl">$doc->remove_relation( $tgt [, @types ] )
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_indexcodes_file -->==indexcodes_file==
+
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.
  
−
  $filename = $doc-&gt;indexcodes_file
+
If you want to remove all relations do $doc-&gt;set_value( "relation", [] );
  
−
Return the filename in which this document uses to cache indexcodes  extracted from the words cache file.
+
<!-- Edit below this comment -->
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_cache_file -->==cache_file==
 
  
−
  $filename = $doc-&gt;cache_file( $suffix );
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_has_relation -->
 +
===has_relation===
  
−
Return a cache filename for this document with the givven suffix.
+
<source lang="perl">$bool = $doc->has_relation( $tgt [, @types ] )
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
+
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.
−
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_create -->==create==
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_create_from_data -->==create_from_data==
 
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_doc_with_eprintid_and_pos -->==doc_with_eprintid_and_pos==
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_icon_url -->==icon_url==
+
<!-- Pod2Wiki=head_search_related -->
 +
===search_related===
  
−
<!-- End of Pod2Wiki -->
+
<source lang="perl">$list = $doc->search_related( [ $type ] )
−
<!-- Pod2Wiki=item_main_input_tags -->==main_input_tags==
 
  
−
<!-- End of Pod2Wiki -->
+
</source>
−
<!-- Pod2Wiki=item_main_render_option -->==main_render_option==
+
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.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_make_thumbnails -->==make_thumbnails==
 
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_mime_type -->==mime_type==
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_register_parent -->==register_parent==
+
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
Copyright 2000-2011 University of Southampton.
  
−
<!-- End of Pod2Wiki -->
+
This file is part of EPrints http://www.eprints.org/.
−
<!-- Pod2Wiki=item_remove_thumbnails -->==remove_thumbnails==
 
  
−
<!-- End of Pod2Wiki -->
+
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
−
<!-- Pod2Wiki=item_render_icon_link -->==render_icon_link==
 
  
−
<!-- End of Pod2Wiki -->
+
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
−
<!-- Pod2Wiki=item_thumbnail_path -->==thumbnail_path==
 
  
−
<!-- End of Pod2Wiki -->
+
You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
−
<!-- Pod2Wiki=item_thumbnail_plugin -->==thumbnail_plugin==
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- Pod2Wiki=item_thumbnail_url -->==thumbnail_url==
 
  
−
<!-- End of Pod2Wiki -->
 
−
<!-- Pod2Wiki=item_user_can_view -->==user_can_view==
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=_postamble_ -->
 +
<!-- Edit below this comment -->

Revision as of 09:57, 22 January 2013

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

API: Core API

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


NAME

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


DESCRIPTION

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:

  • docid (text)
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.
This should probably have been and "int" but isn't. I later version of EPrints may change this.
  • eprintid (itemref)
The id number of the eprint to which this document belongs.
  • placement (int)
Placement of the document - the order documents should be shown in.
  • format (namedset)
The format of this document. One of the types of the dataset "document".
  • formatdesc (text)
An additional description of this document. For example the specific version of a format.
  • language (namedset)
The ISO ID of the language of this document. The default configuration of EPrints does not set this.
  • security (namedset)
The security type of this document - who can view it. One of the types of the dataset "security".
  • 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.
  • files (subobject, multiple)
A virtual field which represents the list of Files which are part of this record.
  • media
A compound field containing a description of the document media - dimensions, codec etc.


METHODS

get_system_field_info

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

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


get_dataset_id

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

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


get_defaults

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

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


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.


remove

$success = $doc->remove

Attempt to completely delete this document


get_eprint

$eprint = $doc->get_eprint

Return the EPrint this document is associated with.

This is a synonym for get_parent().


get_baseurl

$url = $doc->get_baseurl( [$staff] )

Return the base URL of the document. Overrides the stub in DataObj. $staff is currently ignored.


is_public

$boolean = $doc->is_public()

True if this document has no security set and is in the live archive.


path

$path = $doc->path

Returns the relative path to the document WITHOUT any file.


file_path

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

Returns the relative path to $filename stored in this document. If $filename 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;


get_url

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

Return the full URL of the document. Overrides the stub in DataObj.

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


files

%files = $doc->files

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


remove_file

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

Attempt to remove the given file. Give the filename as it is returned by get_files().


set_main

$doc->set_main( $main_file )

Sets the main file and adjusts format and mime type as necessary. Won't affect the database until a $doc->commit().


get_main

$filename = $doc->get_main

Return the name of the main file in this document.


set_format

$doc->set_format( $format )

Set format. Won't affect the database until a commit(). Just an alias for $doc->set_value( "format" , $format );


set_format_desc

$doc->set_format_desc( $format_desc )

Set the format description. Won't affect the database until a commit(). Just an alias for $doc->set_value( "format_desc" , $format_desc );


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 $fileobj created or undef on failure.


add_archive

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

$file is the full path to an archive file, eg. zip or .tar.gz

This function will add the contents of that archive to the document.


add_directory

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

Upload the contents of $directory to this document. This will not set the main file.

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


upload_url

$success = $doc->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.

This (by default) uses wget. The details can be configured in SystemSettings.


commit

$success = $doc->commit

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

Calls "set_document_automatic_fields" in the ArchiveConfig first to set any automatic fields that may be needed.


validate

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

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.


get_type

$type = $doc->get_type

Return the type of this document.


files_modified

$doc->files_modified

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


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.


make_indexcodes

$doc = $doc->make_indexcodes()

Make the indexcodes document for this document. Returns the generated document or undef on failure.


remove_indexcodes

$doc = $doc->remove_indexcodes()

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


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 docs.
  • public => 1
Show thumbnail/preview on all docs if poss.


render_preview_link

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

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

Options:

  • caption => $frag
XHTML fragment to use as the caption, defaults to empty.
  • set => "foo"
The name of the set this document belongs to, defaults to none (preview won't be shown as part of a set).


add_relation

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

Add one or more relations to $doc pointing to $tgt (does not modify $tgt).


remove_relation

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

If you want to remove all relations do $doc->set_value( "relation", [] );


has_relation

$bool = $doc->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.


search_related

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

Return a EPrints::List that contains all documents related to this document. If $type is defined returns only those documents related by $type.


COPYRIGHT

Copyright 2000-2011 University of Southampton.

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

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.



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