Document fields automatic.pl - Revision history

Drn@ecs.soton.ac.uk: Added actually file name in bold.

2022-01-27T12:14:44Z

Added actually file name in bold.

Pm705 at 14:47, 18 August 2010

2010-08-18T14:47:14Z

Pm705 at 14:46, 18 August 2010

2010-08-18T14:46:18Z

Pm705 at 14:38, 18 August 2010

2010-08-18T14:38:23Z

Pm705 at 14:38, 18 August 2010

2010-08-18T14:38:04Z

Pm705 at 14:32, 18 August 2010

2010-08-18T14:32:53Z

Pm705: Created page with '{{dirs}} {{cfgd}} This file contains the set_document_fields_automatic function. You use this function to perform at set of actions which you want to happen automatically before…'

2010-08-03T10:53:39Z

Created page with '{{dirs}} {{cfgd}} This file contains the set_document_fields_automatic function. You use this function to perform at set of actions which you want to happen automatically before…'

New page

{{dirs}}
{{cfgd}}

This file contains the set_document_fields_automatic function. You use this function to perform at set of actions which you want to happen automatically before the [[API:EPrints/DataObj/Document|Document]] as part of the [[API:EPrints/DataObj/Document|Document]] commit() step, in which the document is written to the database.

==Example==

@@ Line 2: / Line 2: @@
 {{cfgd}}
-This file contains the set_document_fields_automatic function. You use this function to perform a set of actions which you want to happen automatically before the [[API:EPrints/DataObj/Document|Document]] as part of the [[API:EPrints/DataObj/Document|Document]] commit() step, in which the document is written to the database.
+'''document_fields_automatic.pl''' contains the '''set_document_fields_automatic''' function. You use this function to perform a set of actions which you want to happen automatically before the [[API:EPrints/DataObj/Document|Document]] as part of the [[API:EPrints/DataObj/Document|Document]] commit() step, in which the document is written to the database.
 * $doc is the [[API:EPrints/DataObj/Document|Document]] object

@@ Line 12: / Line 12: @@
          my( $doc ) = @_;
          if($doc->value("description") eq ""){
-                  $doc->value("description", "the default description");
+                  $doc->value("description", "the default description"); #if the documents description is empty set it to a holding value
+         }
 };
 </pre>

@@ Line 4: / Line 4: @@
 This file contains the set_document_fields_automatic function. You use this function to perform a set of actions which you want to happen automatically before the [[API:EPrints/DataObj/Document|Document]] as part of the [[API:EPrints/DataObj/Document|Document]] commit() step, in which the document is written to the database.
-* $data is a hash of the metadata which will make up the document object. Each field name is a key in the hash.
+* $doc is the [[API:EPrints/DataObj/Document|Document]] object
 ==Example==
 <pre>
-$c->{set_document_defaults} = sub
+$c->{set_document_automatic_fields} = sub
+{
-         my( $data, $session, $eprint ) = @_;
+         my( $doc ) = @_;
+         if($doc->value("description") eq ""){
-         $data->{language} = $session->get_langid();
+                 $doc->value("description", "the default description");
-         $data->{security} = "public";
 };
 </pre>

@@ Line 4: / Line 4: @@
 This file contains the set_document_fields_automatic function. You use this function to perform a set of actions which you want to happen automatically before the [[API:EPrints/DataObj/Document|Document]] as part of the [[API:EPrints/DataObj/Document|Document]] commit() step, in which the document is written to the database.
-$data is a hash of the metadata which will make up the document object. Each field name is a key in the hash.
+* $data is a hash of the metadata which will make up the document object. Each field name is a key in the hash.
-$session is a [[API:EPrints/Repository|Repository]] object (in 3.2 or later)
+* $session is a [[API:EPrints/Repository|Repository]] object (in 3.2 or later)
-$eprint is the [[API:EPrints/DataObj/EPrint|EPrint]] object to which the document belongs
+* $eprint is the [[API:EPrints/DataObj/EPrint|EPrint]] object to which the document belongs
 ==Example==

← Older revision		Revision as of 14:32, 18 August 2010
Line 5:		Line 5:

	==Example==		==Example==
		+	<pre>
		+	$c->{set_document_defaults} = sub
		+	{
		+	my( $data, $session, $eprint ) = @_;
		+
		+	$data->{language} = $session->get_langid();
		+	$data->{security} = "public";
		+	};
		+	</pre>