From EPrints Documentation
Revision as of 13:05, 17 June 2010 by Tdb01r (talk | contribs)
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.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


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

User Comments


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:

User Comments

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.

User Comments

eprintid (itemref)

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

User Comments

placement (int)

Placement of the document - the order documents should be shown in.

User Comments

format (namedset)

The format of this document. One of the types of the dataset "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 ID 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 dataset "security".

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

files (subobject, multiple)

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

User Comments


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

User Comments


User Comments


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

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

User Comments


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

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

User Comments


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

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

User Comments


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

User Comments


$success = $doc->remove

Attempt to completely delete this document

User Comments


$eprint = $doc->get_eprint

Return the EPrint this document is associated with.

This is a synonym for get_parent().

User Comments


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

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

User Comments


$boolean = $doc->is_public()

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

User Comments


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

User Comments


$path = $doc->local_path

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

User Comments


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

User Comments


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

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

User Comments


$doc->set_main( $main_file )

Sets the main file. Won't affect the database until a $doc->commit().

User Comments


$filename = $doc->get_main

Return the name of the main file in this document.

User Comments


$doc->set_format( $format )

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

User Comments


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

User Comments


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

Upload the contents of the given file handle into this document as the given filename.

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

User Comments


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

User Comments


$cleanfilename = sanitise( $filename )

Return just the filename (no leading path) and convert any naughty characters to underscore.

User Comments


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

(In case the over-loading of the word "archive" is getting confusing, in this context we mean ".zip" or ".tar.gz" archive.)

User Comments


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

User Comments


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

User Comments


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

User Comments


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

User Comments


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

User Comments


$type = $doc->get_type

Return the type of this document.

User Comments



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

User Comments



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


$doc = $doc->make_indexcodes()

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

User Comments


$doc = $doc->remove_indexcodes()

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

User Comments


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

Return a cache filename for this document with the givven suffix.

User Comments


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

Render a link to the icon for this document.


User Comments


new_window => 1

Make link go to _blank not current window.

User Comments


preview => 1

If possible, provide a preview pop-up.

User Comments


public => 0

Show thumbnail/preview only on public docs.

User Comments


public => 1

Show thumbnail/preview on all docs if poss.

User Comments


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

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


User Comments


caption => $frag

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

User Comments


set => "foo"

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

User Comments