From EPrints Documentation
Revision as of 09:57, 22 January 2013 by Tdb01r (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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


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


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


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.



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

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


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

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


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

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


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


$success = $doc->remove

Attempt to completely delete this document


$eprint = $doc->get_eprint

Return the EPrint this document is associated with.

This is a synonym for get_parent().


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

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


$boolean = $doc->is_public()

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


$path = $doc->path

Returns the relative path to the document WITHOUT any file.


$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;


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


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

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


$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().


$filename = $doc->get_main

Return the name of the main file in this document.


$doc->set_format( $format )

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


$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 );


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


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


$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 (/).


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


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


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


$type = $doc->get_type

Return the type of this document.



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



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


$doc = $doc->make_indexcodes()

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


$doc = $doc->remove_indexcodes()

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


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

Render a link to the icon for this document.


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


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

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


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


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

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


$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", [] );


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


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