Difference between revisions of "API:EPrints/DataObj/Document"
| Line 1: | Line 1: | ||
<!-- Pod2Wiki=_preamble_ | <!-- 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. | 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/Document.pm|package_name=EPrints::DataObj::Document}}[[Category:API| | + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=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 --> |
Revision as of 15:10, 25 February 2010
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
Contents
- 1 NAME
- 2 DESCRIPTION
- 3 METHODS
- 3.1 get_system_field_info
- 3.2 get_dataset_id
- 3.3 get_defaults
- 3.4 clone
- 3.5 remove
- 3.6 get_eprint
- 3.7 get_baseurl
- 3.8 is_public
- 3.9 get_url
- 3.10 local_path
- 3.11 files
- 3.12 remove_file
- 3.13 set_main
- 3.14 get_main
- 3.15 set_format
- 3.16 set_format_desc
- 3.17 upload
- 3.18 add_file
- 3.19 sanitise
- 3.20 upload_archive
- 3.21 add_archive
- 3.22 add_directory
- 3.23 upload_url
- 3.24 commit
- 3.25 validate
- 3.26 get_type
- 3.27 files_modified
- 3.28 rehash
- 3.29 make_indexcodes
- 3.30 remove_indexcodes
- 3.31 cache_file
- 3.32 render_icon_link
- 3.33 new_window_1
- 3.34 preview_1
- 3.35 public_0
- 3.36 public_1
- 3.37 render_preview_link
- 3.38 caption_frag
- 3.39 set_foo
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.
documents (subobject, multiple)
A virtual field which represents the list of Documents which are part of this record.
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.
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.
local_path
$path = $doc->local_path
Return the full path of the directory where this document is stored in the filesystem.
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. 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 );
upload
$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.
add_file
$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)
sanitise
$cleanfilename = sanitise( $filename )
Return just the filename (no leading path) and convert any naughty characters to underscore.
upload_archive
$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.)
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.
cache_file
$filename = $doc->cache_file( $suffix );
Return a cache filename for this document with the givven suffix.
render_icon_link
$frag = $doc->render_icon_link( %opts )
Render a link to the icon for this document.
Options:
new_window_1
new_window => 1
Make link go to _blank not current window.
preview_1
preview => 1
If possible, provide a preview pop-up.
public_0
public => 0
Show thumbnail/preview only on public docs.
public_1
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
caption => $frag
XHTML fragment to use as the caption, defaults to empty.
set_foo
set => "foo"
The name of the set this document belongs to, defaults to none (preview won't be shown as part of a set).
