|
|
| Line 1: |
Line 1: |
| <!-- Pod2Wiki=_preamble_
| |
| This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
| |
| -->{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/History.pm|package_name=EPrints::DataObj::History}}[[Category:API|History]]<!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_name -->=NAME=
| |
| '''EPrints::DataObj::History''' - An element in the history of the arcvhive.
| |
|
| |
|
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_description -->=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.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_metadata -->=METADATA=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_historyid -->==historyid==
| |
|
| |
| historyid (int)
| |
|
| |
| The unique numerical ID of this history event.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_userid -->==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).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_datasetid -->==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.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_objectid -->==objectid==
| |
|
| |
| objectid (int)
| |
|
| |
| The numerical ID of the object in the dataset.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_revision -->==revision==
| |
|
| |
| revision (int)
| |
|
| |
| The revision of the object. This is the revision number after the action occured. Not all actions increase the revision number.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_timestamp -->==timestamp==
| |
|
| |
| timestamp (time)
| |
|
| |
| The moment at which this thing happened.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_action -->==action==
| |
|
| |
| action (set)
| |
|
| |
| The type of event. Provisionally, this is a subset of the new list of privilages.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_details -->==details==
| |
|
| |
| details (longtext)
| |
|
| |
| If this is a "rejection" then the details contain the message sent to the user.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_methods -->=METHODS=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==
| |
|
| |
| $field_info = EPrints::DataObj::History->get_system_field_info
| |
|
| |
| Return the metadata field configuration for this object.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new -->==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.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new_from_data -->==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.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_commit -->==commit==
| |
|
| |
| $history->commit
| |
|
| |
| Not meaningful. History can't be altered.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_remove -->==remove==
| |
|
| |
| $history->remove
| |
|
| |
| Not meaningful. History can't be altered.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_defaults -->==get_defaults==
| |
|
| |
| $defaults = EPrints::DataObj::History->get_defaults( $session, $data )
| |
|
| |
| Return default values for this object based on the starting data.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render -->==render==
| |
|
| |
| $xhtml = $history->render
| |
|
| |
| Render this change as XHTML DOM.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_dataobj -->==get_dataobj==
| |
|
| |
| $object = $history->get_dataobj
| |
|
| |
| Returns the object to which this history event relates.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_user -->==get_user==
| |
|
| |
| $user = $history->get_user
| |
|
| |
| Returns the user object of the user who caused this event.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
| |
| {{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_create -->==create==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_diff -->==diff==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_empty_tree -->==empty_tree==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_mkpad -->==mkpad==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_mktext -->==mktext==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_citation -->==render_citation==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_create -->==render_create==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_modify -->==render_modify==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_removal_request -->==render_removal_request==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_with_details -->==render_with_details==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_xml -->==render_xml==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_render_xml_diffs -->==render_xml_diffs==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
| |