API:EPrints/DataObj/Subject

From EPrints Documentation
Jump to: navigation, search

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::Subject - Class and methods relating to the subejcts tree.


DESCRIPTION

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

  • $thing = EPrints::DataObj::Subject->get_system_field_info
Return an array describing the system metadata of the Subject dataset.
  • $subject = EPrints::DataObj::Subject->new( $session, $subjectid )
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->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.
  • $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.
  • $success = $subject->remove
Remove this subject from the database.
  • $dataset = EPrints::DataObj::Subject->get_dataset_id
Returns the id of the EPrints::DataSet object to which this record belongs.
  • EPrints::DataObj::Subject::remove_all( $session )
Static function.
Remove all subjects from the database. Use with care!
  • $subject = $subject->top()
Returns the subject that is at the top of this subject's tree (which may be this subject).
Returns undef if the subject is not part of a tree.
  • $child_subject = $subject->create_child( $id, $name, $depositable )
Similar to EPrints::DataObj::Subject::create, but this creates the new subject as a child of the current subject.
  • @children = $subject->get_children
Return a list of EPrints::DataObj::Subject objects which are direct children of the current subject.
  • @parents = $subject->get_parents
Return a list of EPrints::DataObj::Subject objects which are direct parents of the current subject.
  • $boolean = $subject->can_post( [$user] )
Determines whether the given user 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.
  • $xhtml = $subject->render_with_path( $session, $topsubjid )
Return the name of this subject including it's path from $topsubjid.
$topsubjid must be an ancestor of this subject.
eg.
Library of Congress > B Somthing > BC Somthing more Detailed
  • @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.
  • $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 identifier 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" ]
 ]
  • ( $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.
  • $count = $subject->count_eprints( $dataset )
Return the number of eprints in the dataset which are in this subject or one of its decendants. Search all fields of type subject.
  • $boolean = EPrints::DataObj::Subject::valid_id( $id )
Return true if the string is an acceptable identifier for a subject.
This does not check all possible illegal values, yet.
  • $subj->render()
undocumented



COPYRIGHT

Copyright 2000-2011 University of Southampton.

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.

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.

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