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

From EPrints Documentation
Jump to: navigation, search
Line 24: Line 24:
 
     eprintid => $eprint->get_id,
 
     eprintid => $eprint->get_id,
 
   };
 
   };
   my $doc_ds = $handle->get_repository->get_dataset( 'document' );
+
   my $doc_ds = $handle->get_dataset( 'document' );
 
   my $document = $doc_ds->create_object( $handle, $doc_data );
 
   my $document = $doc_ds->create_object( $handle, $doc_data );
 
    
 
    
Line 36: Line 36:
 
    
 
    
 
   # get an existing document
 
   # get an existing document
   $document = EPrints::DataObj::EPrint->new( $handle, $doc_id );
+
   $document = $handle->get_document( $doc_id );
 
   # or
 
   # or
 
   foreach my $doc ( $eprint->get_all_documents ) { ... }
 
   foreach my $doc ( $eprint->get_all_documents ) { ... }

Revision as of 19:13, 25 August 2009


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.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

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

User Comments


SYNOPSIS

 Inherrits all methods from EPrints::DataObj.
 
 # create a new document on $eprint 
 my $doc_data = {
   _parent => $eprint,
   eprintid => $eprint->get_id,
 };
 my $doc_ds = $handle->get_dataset( 'document' );
 my $document = $doc_ds->create_object( $handle, $doc_data );
 
 # Add files to the document  
 $success = $doc->add_file( $file, $filename, [$preserve_path] );
 $success = $doc->upload( $filehandle, $filename [, $preserve_path [, $filesize ] ] );
 $success = $doc->upload_archive( $filehandle, $filename, $archive_format );
 $success = $doc->add_archive( $file, $archive_format );
 $success = $doc->add_directory( $directory );
 $success = $doc->upload_url( $url );
 
 # get an existing document
 $document = $handle->get_document( $doc_id );
 # or
 foreach my $doc ( $eprint->get_all_documents ) { ... }
 
 # eprint to which this document belongs
 $eprint = $doc->get_eprint;
 
 # delete a document object *forever*:
 $success = $doc->remove;
 
 $url = $doc->get_url( [$file] );
 $path = $doc->local_path;
 %files = $doc->files;
 
 # delete a file
 $success = $doc->remove_file( $filename );
 # delete all files
 $success = $doc->remove_all_files;
 
 # change the file which is used as the URL for the document.
 $doc->set_main( $main_file );
 
 # icons and previews
 $xhtml = $doc->render_icon_link( %opts );
 $xhtml = $doc->render_preview_link( %opts );
 

User Comments


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:

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 namedset "security".

User Comments


content (namedset)

The type of content. Conceptual type, no format. ie. Supporting Material or published version. Values from namedset "content"

User Comments


license (namedset)

The type of license for the document. Such as GFDL or creative commons. Values from namedset "licenses"

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


documents (subobject, multiple)

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

User Comments


METHODS

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


$eprint = $doc->get_eprint

Return the EPrint this document is associated with.

This is a synonym for get_parent().

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.

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


$success = $doc->remove_all_files

Attempt to remove all files associated with this document.

User Comments


$doc->set_main( $main_file )

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

This checks the file exists, so is more than an alias for get_value.

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


$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


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


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