API:EPrints/DataObj/Document - Revision history

Pod2wiki at 00:38, 3 January 2022

2022-01-03T00:38:05Z

Pod2wiki at 00:34, 3 January 2022

2022-01-03T00:34:47Z

← Older revision		Revision as of 00:34, 3 January 2022
Line 1,422:		Line 1,422:
	====sanitise====		====sanitise====

	$cleanfilename = EPrints::DataObj::Document sanitise( $filename )		$cleanfilename = EPrints::DataObj::Document::sanitise( $filename )

	~~DEPRECATED - Use~~ [[API:EPrints/System#sanitise\|EPrints::System#sanitise]].		Sanitises filename by replacing invalid characters. Mainly uses
			[[API:EPrints/System#sanitise\|EPrints::System#sanitise]] but also replaces <tt>/</tt> with <tt>_</tt> to
	~~Sanitises filename by replacing invalid characters~~.		ensure these do not get confused as a separator between direectories.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 00:04, 3 January 2022

2022-01-03T00:04:19Z

Show changes

Pod2wiki at 17:11, 29 December 2021

2021-12-29T17:11:46Z

← Older revision		Revision as of 17:11, 29 December 2021
Line 250:		Line 250:
	===get_system_field_info===		===get_system_field_info===

	$~~metadata~~ = EPrints::DataObj::Document->get_system_field_info		$fields = EPrints::DataObj::Document->get_system_field_info
	Returns an array describing the system metadata of the document dataset.		Returns an array describing the system metadata of the document dataset.

Line 346:		Line 346:

	$defaults = EPrints::DataObj::Document->get_defaults( $class, $session, $data, $dataset )		$defaults = EPrints::DataObj::Document->get_defaults( $class, $session, $data, $dataset )
	~~Return~~ default values for this data object based on the starting <tt>$data</tt>.		Returns default values for this data object based on the starting <tt>$data</tt>.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 389:		Line 389:

	$eprint = $doc->get_eprint		$eprint = $doc->get_eprint
	~~Return~~ the eprint this document is associated with.		Returns the eprint this document is associated with.

	Alias for:		Alias for:
Line 493:		Line 493:

	%files = $doc->files		%files = $doc->files
	~~Return~~ a hash, the keys of which are all the files belonging to this document (relative to [[API:EPrints/DataObj/Document#local_path\|local_path]]). The values are the sizes of the files in bytes.		Returns a hash, the keys of which are all the files belonging to this document (relative to [[API:EPrints/DataObj/Document#local_path\|local_path]]). The values are the sizes of the files in bytes.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 534:		Line 534:

	$filename = $doc->get_main		$filename = $doc->get_main
	~~Return~~ the filename of the file set as <tt>main</tt> in this document.		Returns the filename of the file set as <tt>main</tt> in this document.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 713:		Line 713:

	@derived_docs = $doc->get_derived_versions		@derived_docs = $doc->get_derived_versions
	~~Return~~ an array of documents that are derived from the current document through the <tt>isVersionOf</tt> relation.		Returns an array of documents that are derived from the current document through the <tt>isVersionOf</tt> relation.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 743:		Line 743:

	$boolean = $doc->user_can_view( $user )		$boolean = $doc->user_can_view( $user )
	~~Return~~ <tt>true</tt> if this document's security settings allow the given <tt>$user</tt> access to view it.		Returns <tt>true</tt> if this document's security settings allow the given <tt>$user</tt> access to view it.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 964:		Line 964:

	$plugin = $doc->thumbnail_plugin( $size )		$plugin = $doc->thumbnail_plugin( $size )
	~~Return~~ the plugin used to generatee thumbnails of the specified <tt>$size</tt>.		Returns the plugin used to generatee thumbnails of the specified <tt>$size</tt>.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 20:47, 28 December 2021

2021-12-28T20:47:30Z

@@ Line 51: / Line 51: @@
 The revision number of this document record.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 205: / Line 181: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_relation -->
+<!-- Pod2Wiki=item_media -->
-===relation (relation, multiple)===
+===media (compound)===
-Predicated relationships between this document and other data objects  within the archive.
+A virtual field which represents the list of files which are part of this record.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 217: / Line 226: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_media -->
+<!-- Pod2Wiki=item_relation -->
-===media (compound)===
+===relation (relation, multiple)===
-A compound field containing a description of the document media - dimensions, codec etc.
+Predicated relationships between this document and other data objects within the archive.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 336: / Line 345: @@
 ===get_defaults===
-  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $session, $data )
+  $defaults = EPrints::DataObj::Document-&gt;get_defaults( $class, $session, $data, $dataset )
 Return default values for this data object based on the starting  <tt>$data</tt>.

Pod2wiki at 10:30, 28 December 2021

2021-12-28T10:30:04Z

Show changes

Pod2wiki at 10:27, 28 December 2021

2021-12-28T10:27:42Z

Show changes

Pod2wiki at 10:25, 28 December 2021

2021-12-28T10:25:27Z

Show changes

Tdb01r at 09:57, 22 January 2013

2013-01-22T09:57:13Z

Show changes

Tdb01r at 15:26, 16 December 2011

2011-12-16T15:26:26Z

← Older revision		Revision as of 15:26, 16 December 2011
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\|DOCUMENT]][[Category:API:EPrints/DataObj\|DOCUMENT]][[Category:API:EPrints/DataObj/Document\|DOCUMENT]]<div><!-- Edit below this comment -->		-->{{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 -->