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

From EPrints Documentation
Jump to: navigation, search
m (DESCRIPTION: typo correction)
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.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/DataObj/Subject.pm|package_name=EPrints::DataObj::Subject}}[[Category:API|SUBJECT]][[Category:API:EPrints/DataObj|SUBJECT]][[Category:API:EPrints/DataObj/Subject|SUBJECT]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Subject.pm|package_name=EPrints::DataObj::Subject}}[[Category:API|SUBJECT]][[Category:API:EPrints/DataObj|SUBJECT]]<div><!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
'''EPrints::DataObj::Subject''' - Class and methods relating to the subejcts tree.
+
'''EPrints::DataObj::Subject''' - Class and methods relating to the subjects tree.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 +
</div>
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
 
This class represents a single node in the subejcts tree. It also contains a number of methods for handling the entire tree.
 
This class represents a single node in the subejcts tree. It also contains a number of methods for handling the entire tree.
  
EPrints::DataObj::Subject is a subclass of EPrints::DataObj
+
This class is a subclass of [[API:EPrints/DataObj|EPrints::DataObj]].
  
* $thing = EPrints::DataObj::Subject-&gt;get_system_field_info
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
: Return an array describing the system metadata of the Subject dataset.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_constructor_methods -->
 +
===Constructor Methods===
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_new -->
 +
====new====
 +
 
 +
$subject = EPrints::DataObj::Subject-&gt;new( $session, $subjectid )
 +
Create a new subject object with the ID <tt>$subjectid</tt>. The values for the subject are loaded from the database.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_new_from_data -->
 +
====new_from_data====
 +
 
 +
$subject = EPrints::DataObj::Subject-&gt;new_from_data( $session, $data )
 +
Construct a new subject object from a hash reference containing the relevant fields. Generally this method is only used to construct new Subjects coming out of the database.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_create -->
 +
====create====
 +
 
 +
$subject = EPrints::DataObj::Subject::create( $session, $id, $name, $parents, $depositable )
 +
Creates a new subject in the database. <tt>$id</tt> is the ID of the  subject, <tt>$name</tt> is a multilang data structure with the name of the  subject in one or more languages. E.g.
 +
{ en=&gt;"Trousers", en-us=&gt;"Pants } <tt>$parents</tt> is a reference to an array containing the ID of one or more  other subjects (don't make loops!). If <tt>$depositable</tt> is <tt>true</tt> then  data objects (typically eprints) may belong to this subject.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_create_from_data -->
 +
====create_from_data====
 +
 
 +
$dataobj = EPrints::DataObj::Subject-&gt;create_from_data( $session, $data, $dataset )
 +
Returns <tt>undef</tt> if a bad (or no) <tt>subjectid</tt> is specified in <tt>$data</tt>.
 +
 
 +
Otherwise calls the parent method in [[API:EPrints/DataObj|EPrints::DataObj]].
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_class_methods -->
 +
===Class Methods===
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_system_field_info -->
 +
====get_system_field_info====
 +
 
 +
$fields = EPrints::DataObj::Subject-&gt;get_system_field_info
 +
Returns an array describing the system metadata of the subject  dataset.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_dataset_id -->
 +
====get_dataset_id====
 +
 
 +
$dataset = EPrints::DataObj::Subject-&gt;get_dataset_id
 +
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record  belongs.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_object_methods -->
 +
===Object Methods===
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_commit -->
 +
====commit====
 +
 
 +
$success = $subject-&gt;commit( [ $force ] )
 +
Commit this subject to the database, but only if any fields have  changed since we loaded it.
 +
 
 +
If <tt>$force</tt> is set then always commit, even if there appear to be no changes.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_remove -->
 +
====remove====
 +
 
 +
$success = $subject-&gt;remove
 +
Remove this subject from the database.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item__get_ancestors -->
 +
====_get_ancestors====
 +
 
 +
@subject_ids = $subject-&gt;_get_ancestors
 +
Returns and array of all the ancestor subjects of this subject.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_top -->
 +
====top====
 +
 
 +
$subject = $subject-&gt;top
 +
Returns the subject that is at the top of this subject's tree, which  may be the subject itself.
 +
 
 +
Returns <tt>undef</tt> if the subject is not part of a tree.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_create_child -->
 +
====create_child====
 +
 
 +
$child_subject = $subject-&gt;create_child( $id, $name, $depositable )
 +
Similar to [[API:EPrints/DataObj/Subject#create|create]] but this creates a new subject as a child of  the current subject.
  
* $subject = EPrints::DataObj::Subject-&gt;new( $session, $subjectid )
+
<tt>$id</tt> is the ID for the new child subject. <tt>$name</tt> is the label for  this new subject and <tt>$depositable</tt> is a boolean indicating whether  this new subject is depositable.
: Create a new subject object given the id of the subject. The values for the subject are loaded from the database.
 
  
* $subject = EPrints::DataObj::Subject-&gt;new_from_data( $session, $data )
+
Returns the new child subject.
: Construct a new subject object from a hash reference containing the relevant fields. Generally this method is only used to construct new Subjects coming out of the database.
 
  
* $success = $subject-&gt;commit( [$force] )
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
: Commit this subject to the database, but only if any fields have  changed since we loaded it.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_children -->
 +
====get_children====
  
: If $force is set then always commit, even if there appear to be no changes.
+
@children = $subject-&gt;get_children
 +
Returns a list of subject data objects which are direct children of  the current subject.
  
* $success = $subject-&gt;remove
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
: Remove this subject from the database.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
* $dataset = EPrints::DataObj::Subject-&gt;get_dataset_id
 
: Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
 
  
* EPrints::DataObj::Subject::remove_all( $session )
+
<!-- Pod2Wiki= -->
: Static function.
+
</div>
 +
<!-- Pod2Wiki=item_get_parents -->
 +
====get_parents====
  
: Remove all subjects from the database. Use with care!
+
@parents = $subject-&gt;get_parents
 +
Returns a list of subject data objects which are direct parents of the current subject.
  
* $subject = $subject-&gt;top()
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
: Returns the subject that is at the top of this subject's tree (which may be this subject).
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
: Returns undef if the subject is not part of a tree.
 
  
* $child_subject = $subject-&gt;create_child( $id, $name, $depositable )
+
<!-- Pod2Wiki= -->
: Similar to EPrints::DataObj::Subject::create, but this creates the new subject as a child of the current subject.
+
</div>
 +
<!-- Pod2Wiki=item_can_post -->
 +
====can_post====
  
* @children = $subject-&gt;get_children
+
$boolean = $subject-&gt;can_post( [ $user ] )
: Return a list of EPrints::DataObj::Subject objects which are direct children of the current subject.
+
Determines whether the given <tt>$user</tt> if specified can post in this  subject.
  
* @parents = $subject-&gt;get_parents
+
Currently there is no way to configure subjects for certain users, so this just returns the <tt>true</tt> or <tt>false</tt> depending on the  <tt>depositable</tt> flag.
: Return a list of EPrints::DataObj::Subject objects which are direct parents of the current subject.
 
  
* $boolean = $subject-&gt;can_post( [$user] )
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
: Determines whether the given user can post in this subject.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
: Currently there is no way to configure subjects for certain users, so this just returns the true or false depending on the "depositable" flag.
 
  
* $xhtml = $subject-&gt;render_with_path( $session, $topsubjid )
+
<!-- Pod2Wiki= -->
: Return the name of this subject including it's path from $topsubjid.
+
</div>
 +
<!-- Pod2Wiki=item_render_with_path -->
 +
====render_with_path====
  
: $topsubjid must be an ancestor of this subject.
+
$xhtml = $subject-&gt;render_with_path( $session, $topsubjid )
 +
Returns the XHTML DOM rendering name of this subject including it's  path from <tt>$topsubjid</tt>.
  
: eg.  
+
<tt>$topsubjid</tt> must be an ancestor of this subject.
  
: Library of Congress &gt; B Somthing &gt; BC Somthing more Detailed
+
E.g.
  
* @paths = $subject-&gt;get_paths( $session, $topsubjid )
+
Library of Congress &gt; B Somthing &gt; BC Somthing more Detailed
: This function returns all the paths from this subject back up to the specified top subject.
+
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
: @paths is an array of array references. Each of the inner arrays is a list of subject id's describing a path down the tree from $topsubjid to $session.
 
  
* $subject_pairs = $subject-&gt;get_subjects ( [$postable_only], [$show_top_level], [$nes_tids], [$no_nest_label] )
+
<!-- Pod2Wiki= -->
: Return a reference to an array. Each item in the array is a two  element list.
+
</div>
 +
<!-- Pod2Wiki=item_get_paths -->
 +
====get_paths====
  
: The first element in the list is an identifier string.  
+
@paths = $subject-&gt;get_paths( $session, $topsubjid )
 +
This function returns all the paths from this subject back up to the specified top subject.
  
: The second element is a utf-8 string describing the subject (in the  current language), including all the items above it in the tree, but only as high as this subject.
+
@paths is an array of array references. Each of the inner arrays is a list of subject id's describing a path down the tree from $topsubjid to $session.
  
: The subjects which are returned are this item and all its children,  and childrens children etc. The order is it returns this subject, then the first child of this subject, then children of  that (recursively), then the second child of this subject etc.
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
: If $postable_only is true then filter the results to only contain  subjects which have the "depositable" flag set to true.
 
  
: If $show_top_level is not true then the pair representing the current subject is not included at the start of the list.
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_get_subjects -->
 +
====get_subjects====
  
: If $nest_ids is true then each then the ids retured are nested so that the ids of the children of this subject are prefixed with this  subjects id and a colon, and their children are prefixed by their  nested id and a colon. eg. L:LC:LC003 rather than just "LC003"
+
$subject_pairs = $subject-&gt;get_subjects ( [$postable_only], [$show_top_level], [$nes_tids], [$no_nest_label] )
 +
Return a reference to an array. Each item in the array is a two  element list.  
  
: if $no_nest_label is true then the subject label only contains the name of the subject, not the higher level ones.
+
The first element in the list is an indenifier string.  
  
: A default result from this method would look something like this:
+
The second element is a utf-8 string describing the subject (in the  current language), including all the items above it in the tree, but only as high as this subject.
  
<pre> [
+
The subjects which are returned are this item and all its children, and childrens children etc. The order is it returns  this subject, then the first child of this subject, then children of  that (recursively), then the second child of this subject etc.
 +
 
 +
If $postable_only is true then filter the results to only contain  subjects which have the "depositable" flag set to true.
 +
 
 +
If $show_top_level is not true then the pair representing the current subject is not included at the start of the list.
 +
 
 +
If $nest_ids is true then each then the ids retured are nested so that the ids of the children of this subject are prefixed with this  subjects id and a colon, and their children are prefixed by their  nested id and a colon. eg. L:LC:LC003 rather than just "LC003"
 +
 
 +
if $no_nest_label is true then the subject label only contains the name of the subject, not the higher level ones.
 +
 
 +
A default result from this method would look something like this:
 +
 
 +
  [
 
     [ "D", "History" ],
 
     [ "D", "History" ],
 
     [ "D1", "History: History (General)" ],
 
     [ "D1", "History: History (General)" ],
 
     [ "D111", "History: History (General): Medieval History" ]
 
     [ "D111", "History: History (General): Medieval History" ]
  ]</pre>
+
  ]
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item__get_subjects2 -->
 +
====_get_subjects2====
 +
 
 +
$subjects = $subject-&gt;_get_subjects2( $postableonly, $hidenode, $nestids, $subjectmap, $rmap, $prefix )
 +
Recursive function used by get_subjects.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_count_eprints -->
 +
====count_eprints====
 +
 
 +
$count = $subject-&gt;count_eprints( $dataset )
 +
Returns the number of data objects in the dataset (typically eprints), which are in this subject or one of its decendants. Searches all  fields of type subject.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_render_description -->
 +
====render_description====
 +
 
 +
$subject-&gt;render_description
 +
Returns a rendering describing the subject.
 +
 
 +
This is an alias for:
 +
 
 +
$subject-&gt;render_value( "name" )
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_utility_methods -->
 +
===Utility Methods===
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
* ( $subject_map, $reverse_map ) = EPrints::DataObj::Subject::get_all( $session )
 
: Get all the subjects for the current archvive of $session.
 
  
: $subject_map is a reference to a hash. The keys of the hash are the id's of the subjects. The values of the hash are the EPrint::Subject object relating to that id.
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_remove_all -->
 +
====remove_all====
 +
 
 +
EPrints::DataObj::Subject::remove_all( $session )
 +
Remove all subjects from the database. Use with care!
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
: $reverse_map is a reference to a hash. Each key is the id of a subject. Each value is a reference to an array. The array contains a EPrints::DataObj::Subject objects, one for each child of the subject  with the id. The array is sorted by the labels for the subjects, in the current language.
 
  
* $count = $subject-&gt;count_eprints( $dataset )
+
<!-- Pod2Wiki= -->
: Return the number of eprints in the dataset which are in this subject or one of its decendants. Search all fields of type subject.
+
</div>
 +
<!-- Pod2Wiki=item_get_all -->
 +
====get_all====
  
* $boolean = EPrints::DataObj::Subject::valid_id( $id )
+
( $subject_map, $reverse_map ) = EPrints::DataObj::Subject::get_all( $session )
: Return true if the string is an acceptable identifier for a subject.
+
Get all the subjects for the current archvive of $session.
  
: This does not check all possible illegal values, yet.
+
$subject_map is a reference to a hash. The keys of the hash are the id's of the subjects. The values of the hash are the EPrint::Subject object relating to that id.
  
* $subj-&gt;render()
+
$reverse_map is a reference to a hash. Each key is the id of a subject. Each value is a reference to an array. The array contains a EPrints::DataObj::Subject objects, one for each child of the subject with the id. The array is sorted by the labels for the subjects, in the current language.
: undocumented
 
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
+
</div>
 +
<!-- Pod2Wiki=item_valid_id -->
 +
====valid_id====
 +
 
 +
$boolean = EPrints::DataObj::Subject::valid_id( $id )
 +
Returns <tt>true</tt> if the string <tt>$id</tt> is an acceptable identifier for a  subject.
 +
 
 +
This does not check all possible illegal values, just that it has no  whitespace.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_deprecated_methods -->
 +
===Deprecated Methods===
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_posted_eprints -->
 +
====posted_eprints====
 +
 
 +
@eprints = $subject-&gt;posted_eprints( $dataset )
 +
DEPRECATED
 +
 
 +
This method is no longer used by EPrints, and may be removed in a later release.
 +
 
 +
Returns all the data objects in the <tt>$dataset</tt>, (typically, <tt>eprint</tt> or its virtual datasets, such as <tt>archive</tt>, <tt>buffer</tt> and <tt>inbox</tt>, which are in this subject (or below it in the tree, its children, etc.). It searches all fields of type <tt>subject</tt>.
  
==COPYRIGHT==
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Copyright 2000-2011 University of Southampton.
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
This file is part of EPrints http://www.eprints.org/.
 
  
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_render -->
 +
====render====
  
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+
$subj-&gt;render
 +
DEPRECATED
  
You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.
+
Subjects cannot be rendered. Use [[API:EPrints/DataObj/Subject#render_description|render_description]] instead.
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
+
</div>
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
{{API:Copyright}}
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 15:49, 31 December 2021

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


NAME

EPrints::DataObj::Subject - Class and methods relating to the subjects tree.

User Comments


DESCRIPTION

This class represents a single node in the subejcts tree. It also contains a number of methods for handling the entire tree.

This class is a subclass of EPrints::DataObj.

User Comments


METHODS

User Comments


Constructor Methods

User Comments


new

$subject = EPrints::DataObj::Subject->new( $session, $subjectid )

Create a new subject object with the ID $subjectid. The values for the subject are loaded from the database.

User Comments


new_from_data

$subject = EPrints::DataObj::Subject->new_from_data( $session, $data )

Construct a new subject object from a hash reference containing the relevant fields. Generally this method is only used to construct new Subjects coming out of the database.

User Comments


create

$subject = EPrints::DataObj::Subject::create( $session, $id, $name, $parents, $depositable )

Creates a new subject in the database. $id is the ID of the subject, $name is a multilang data structure with the name of the subject in one or more languages. E.g.

{ en=>"Trousers", en-us=>"Pants } $parents is a reference to an array containing the ID of one or more  other subjects (don't make loops!). If $depositable is true then  data objects (typically eprints) may belong to this subject.

User Comments


create_from_data

$dataobj = EPrints::DataObj::Subject->create_from_data( $session, $data, $dataset )

Returns undef if a bad (or no) subjectid is specified in $data.

Otherwise calls the parent method in EPrints::DataObj.

User Comments


Class Methods

User Comments


get_system_field_info

$fields = EPrints::DataObj::Subject->get_system_field_info

Returns an array describing the system metadata of the subject dataset.

User Comments


get_dataset_id

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

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

User Comments


Object Methods

User Comments


commit

$success = $subject->commit( [ $force ] )

Commit this subject to the database, but only if any fields have changed since we loaded it.

If $force is set then always commit, even if there appear to be no changes.

User Comments


remove

$success = $subject->remove

Remove this subject from the database.

User Comments


_get_ancestors

@subject_ids = $subject->_get_ancestors

Returns and array of all the ancestor subjects of this subject.

User Comments


top

$subject = $subject->top

Returns the subject that is at the top of this subject's tree, which may be the subject itself.

Returns undef if the subject is not part of a tree.

User Comments


create_child

$child_subject = $subject->create_child( $id, $name, $depositable )

Similar to create but this creates a new subject as a child of the current subject.

$id is the ID for the new child subject. $name is the label for this new subject and $depositable is a boolean indicating whether this new subject is depositable.

Returns the new child subject.

User Comments


get_children

@children = $subject->get_children

Returns a list of subject data objects which are direct children of the current subject.

User Comments


get_parents

@parents = $subject->get_parents

Returns a list of subject data objects which are direct parents of the current subject.

User Comments


can_post

$boolean = $subject->can_post( [ $user ] )

Determines whether the given $user if specified can post in this subject.

Currently there is no way to configure subjects for certain users, so this just returns the true or false depending on the depositable flag.

User Comments


render_with_path

$xhtml = $subject->render_with_path( $session, $topsubjid )

Returns the XHTML DOM rendering name of this subject including it's path from $topsubjid.

$topsubjid must be an ancestor of this subject.

E.g.

Library of Congress > B Somthing > BC Somthing more Detailed
 

User Comments


get_paths

@paths = $subject->get_paths( $session, $topsubjid )

This function returns all the paths from this subject back up to the specified top subject.

@paths is an array of array references. Each of the inner arrays is a list of subject id's describing a path down the tree from $topsubjid to $session.

User Comments


get_subjects

$subject_pairs = $subject->get_subjects ( [$postable_only], [$show_top_level], [$nes_tids], [$no_nest_label] )

Return a reference to an array. Each item in the array is a two element list.

The first element in the list is an indenifier string.

The second element is a utf-8 string describing the subject (in the current language), including all the items above it in the tree, but only as high as this subject.

The subjects which are returned are this item and all its children, and childrens children etc. The order is it returns this subject, then the first child of this subject, then children of that (recursively), then the second child of this subject etc.

If $postable_only is true then filter the results to only contain subjects which have the "depositable" flag set to true.

If $show_top_level is not true then the pair representing the current subject is not included at the start of the list.

If $nest_ids is true then each then the ids retured are nested so that the ids of the children of this subject are prefixed with this subjects id and a colon, and their children are prefixed by their nested id and a colon. eg. L:LC:LC003 rather than just "LC003"

if $no_nest_label is true then the subject label only contains the name of the subject, not the higher level ones.

A default result from this method would look something like this:

 [
   [ "D", "History" ],
   [ "D1", "History: History (General)" ],
   [ "D111", "History: History (General): Medieval History" ]
]
 

User Comments


_get_subjects2

$subjects = $subject->_get_subjects2( $postableonly, $hidenode, $nestids, $subjectmap, $rmap, $prefix )

Recursive function used by get_subjects.

User Comments


count_eprints

$count = $subject->count_eprints( $dataset )

Returns the number of data objects in the dataset (typically eprints), which are in this subject or one of its decendants. Searches all fields of type subject.

User Comments


render_description

$subject->render_description

Returns a rendering describing the subject.

This is an alias for:

$subject->render_value( "name" )
 

User Comments


Utility Methods

User Comments


remove_all

EPrints::DataObj::Subject::remove_all( $session )

Remove all subjects from the database. Use with care!

User Comments


get_all

( $subject_map, $reverse_map ) = EPrints::DataObj::Subject::get_all( $session )

Get all the subjects for the current archvive of $session.

$subject_map is a reference to a hash. The keys of the hash are the id's of the subjects. The values of the hash are the EPrint::Subject object relating to that id.

$reverse_map is a reference to a hash. Each key is the id of a subject. Each value is a reference to an array. The array contains a EPrints::DataObj::Subject objects, one for each child of the subject with the id. The array is sorted by the labels for the subjects, in the current language.

User Comments


valid_id

$boolean = EPrints::DataObj::Subject::valid_id( $id )

Returns true if the string $id is an acceptable identifier for a subject.

This does not check all possible illegal values, just that it has no whitespace.

User Comments


Deprecated Methods

User Comments


posted_eprints

@eprints = $subject->posted_eprints( $dataset )

DEPRECATED

This method is no longer used by EPrints, and may be removed in a later release.

Returns all the data objects in the $dataset, (typically, eprint or its virtual datasets, such as archive, buffer and inbox, which are in this subject (or below it in the tree, its children, etc.). It searches all fields of type subject.

User Comments


render

$subj->render

DEPRECATED

Subjects cannot be rendered. Use render_description instead.

User Comments


COPYRIGHT

© Copyright 2022 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments