API:EPrints/DataObj/History

From EPrints Documentation
Revision as of 18:28, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::DataObj::History - An element in the history of the arcvhive.

DESCRIPTION

This class describes a single item in the history dataset. A history object describes a single action taken on a single item in another dataset.

Changes to document are considered part of changes to the eprint it belongs to.

METADATA

historyid

 historyid (int)

The unique numerical ID of this history event.

userid

 userid (itemref)

The id of the user who caused this event. A value of zero or undefined indicates that there was no user responsible (ie. a script did it).

datasetid

 datasetid (text)

The name of the dataset to which the modified item belongs. "eprint" is used for eprints, rather than the inbox, buffer etc.

objectid

 objectid (int)

The numerical ID of the object in the dataset.

revision

 revision (int)

The revision of the object. This is the revision number after the action occured. Not all actions increase the revision number.

timestamp

 timestamp (time)

The moment at which this thing happened.

action

 action (set)

The type of event. Provisionally, this is a subset of the new list of privilages.

details

 details (longtext)

If this is a "rejection" then the details contain the message sent to the user.

METHODS

get_system_field_info

 $field_info = EPrints::DataObj::History->get_system_field_info

Return the metadata field configuration for this object.

new

 $history = EPrints::DataObj::History->new( $session, $historyid )

Return a history object with id $historyid, from the database.

Return undef if no such object extists.

new_from_data

 undef = EPrints::DataObj::History->new_from_data( $session, $data )

Create a new History object from the given $data. Used to turn items from the database into objects.

commit

 $history->commit 

Not meaningful. History can't be altered.

remove

 $history->remove

Not meaningful. History can't be altered.

get_defaults

 $defaults = EPrints::DataObj::History->get_defaults( $session, $data )

Return default values for this object based on the starting data.

render

 $xhtml = $history->render

Render this change as XHTML DOM.

get_dataobj

 $object = $history->get_dataobj

Returns the object to which this history event relates.

get_user

 $user = $history->get_user

Returns the user object of the user who caused this event.

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

create

diff

empty_tree

mkpad

mktext

render_citation

render_create

render_modify

render_removal_request

render_with_details

render_xml

render_xml_diffs