API:EPrints/DataObj/Access - Revision history

Pod2wiki at 11:11, 10 January 2022

2022-01-10T11:11:20Z

Pod2wiki at 22:26, 1 January 2022

2022-01-01T22:26:45Z

Pod2wiki at 22:10, 1 January 2022

2022-01-01T22:10:06Z

Pod2wiki at 22:05, 1 January 2022

2022-01-01T22:05:34Z

Pod2wiki at 10:29, 27 December 2021

2021-12-27T10:29:48Z

Pod2wiki at 22:32, 26 December 2021

2021-12-26T22:32:08Z

Show changes

Kgoetz: adding Category:Rubbish, page was emptied 9 years ago and has been untouched since

2018-10-03T00:26:01Z

adding Category:Rubbish, page was emptied 9 years ago and has been untouched since

Tdb01r: Removing all content from page

2009-08-12T15:39:43Z

Removing all content from page

@@ Line 18: / Line 18: @@
 ==DESCRIPTION==
 Accesses to particular abstract/summary pages (views) or publication  documents (downloads).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 160: / Line 147: @@
 ID of the document requested (if relevant).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 177: / Line 177: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_get_system_field_info -->
+<!-- Pod2Wiki=head_class_methods -->
-===get_system_field_info===
+===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>
@@ Line 190: / Line 186: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=head_class_methods -->
+<!-- Pod2Wiki=item_get_system_field_info -->
-===Class Methods===
+====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%; '>
 <span style='display:none'>User Comments</span>
@@ Line 224: / Line 224: @@
 ====get_referent_id====
-  $dataobj-&gt;get_referent_id()
+  $referent_id = $access-&gt;get_referent_id
-Returns the fully qualified referent ID.
+Returns the fully-qualified referent ID.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 237: / Line 237: @@
 ====get_requester_id====
-  $dataobj-&gt;get_requester_id
+  $requester_id = $access-&gt;get_requester_id
-Return the fully qualified requester ID.
+Return the fully-qualified requester ID.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 30: / Line 30: @@
 <!-- Pod2Wiki=head_instance_variables -->
 ==INSTANCE VARIABLES==
-<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+See [[API:EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj/INSTANCE_VARIABLES]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 17: / Line 17: @@
 <!-- Pod2Wiki=head_description -->
 ==DESCRIPTION==
 Inherits from [[API:EPrints/DataObj|EPrints::DataObj]].
@@ Line 35: / Line 37: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_$obj->{ -->
+<!-- Pod2Wiki=item_$access->{ -->
-===$obj-&gt;{ "data" }===
+===$access-&gt;{ "data" }===
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 45: / Line 47: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_$obj->{ -->
+<!-- Pod2Wiki=item_$access->{ -->
-===$obj-&gt;{ "dataset" }===
+===$access-&gt;{ "dataset" }===
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 55: / Line 57: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_$obj->{ -->
+<!-- Pod2Wiki=item_$access->{ -->
-===$obj-&gt;{ "session" }===
+===$access-&gt;{ "session" }===
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 75: / Line 77: @@
 </div>
 <!-- Pod2Wiki=item_accessid -->
-===accessid===
+===accessid (counter)===
-Unique id for the access.
+Unique ID for the access.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 87: / Line 89: @@
 </div>
 <!-- Pod2Wiki=item_datestamp -->
-===datestamp===
+===datestamp (timestamp)===
 Time of access.
@@ Line 99: / Line 101: @@
 </div>
 <!-- Pod2Wiki=item_requester_id -->
-===requester_id===
+===requester_id (text)===
-Id of the requesting user-agent (typically IP address).
+ID of the requesting user-agent. (Typically an IP address).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 111: / Line 113: @@
 </div>
 <!-- Pod2Wiki=item_requester_user_agent -->
-===requester_user_agent===
+===requester_user_agent (text)===
-The HTTP user agent string (useful for robots spotting).
+The HTTP user agent string. (Useful for robots spotting).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 123: / Line 125: @@
 </div>
 <!-- Pod2Wiki=item_requester_country -->
-===requester_country===
+===requester_country (text)===
-Country the request originated from.
+The country from which the request originated. (Typically determined  using {{API:PodLink|file=Geo/IP|package_name=Geo::IP|section=|text=Geo::IP}}).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 135: / Line 137: @@
 </div>
 <!-- Pod2Wiki=item_requester_institution -->
-===requester_institution===
+===requester_institution (text)===
-Institution the request originated from.
+The institution from which the request originated. (This could be used  to store the Net-Name from a WHOIS lookup).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 147: / Line 149: @@
 </div>
 <!-- Pod2Wiki=item_referring_entity_id -->
-===referring_entity_id===
+===referring_entity_id (longtext)===
-Id of the object from which the user agent came from (i.e. HTTP referrer).
+ID of the object from which the user agent came from (i.e. HTTP  referrer).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 159: / Line 161: @@
 </div>
 <!-- Pod2Wiki=item_service_type_id -->
-===service_type_id===
+===service_type_id (text)===
-Id of the type of service requested.
+Id of the type of service requested. (E.g. abstract view or full text download).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 171: / Line 173: @@
 </div>
 <!-- Pod2Wiki=item_referent_id -->
-===referent_id===
+===referent_id (int)===
-Id of the object requested.
+ID of the object requested. (Normally the eprint ID).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 183: / Line 185: @@
 </div>
 <!-- Pod2Wiki=item_referent_docid -->
-===referent_docid===
+===referent_docid (int)===
-Id of the document requested (if relevent).
+ID of the document requested (if relevant).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 65: / Line 65: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=head_core_fields -->
+<!-- Pod2Wiki=head_core_metadata_fields -->
-==CORE FIELDS==
+==CORE METADATA FIELDS==
 <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>

← Older revision	Revision as of 00:26, 3 October 2018
Line 1:	Line 1:
−	+	[[Category: Rubbish]]

← Older revision		Revision as of 15:39, 12 August 2009
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/Access.pm\|package_name=EPrints::DataObj::Access}}[[Category:API\|Access]]<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_name -->=NAME=~~
−	~~'''EPrints::DataObj::Access''' - Accesses to the Web server~~

−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_description -->=DESCRIPTION=~~
−	~~Inherits from [[API:EPrints/DataObj\|EPrints::DataObj]].~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_instance_variables -->=INSTANCE VARIABLES=~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_$obj->{ -->==$obj->{==~~
−
−	~~$obj->{ "data" }~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_$obj->{ -->==$obj->{==~~
−
−	~~$obj->{ "dataset" }~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_$obj->{ -->==$obj->{==~~
−
−	~~$obj->{ "session" }~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_core_fields -->=CORE FIELDS=~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_accessid -->==accessid==~~
−
−	~~Unique id for the access.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_datestamp -->==datestamp==~~
−
−	~~Time of access.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_requester_id -->==requester_id==~~
−
−	~~Id of the requesting user-agent (typically IP address).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_requester_user_agent -->==requester_user_agent==~~
−
−	~~The HTTP user agent string (useful for robots spotting).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_requester_country -->==requester_country==~~
−
−	~~Country the request originated from.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_requester_institution -->==requester_institution==~~
−
−	~~Institution the request originated from.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_referring_entity_id -->==referring_entity_id==~~
−
−	~~Id of the object from which the user agent came from (i.e. HTTP referrer).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_service_type_id -->==service_type_id==~~
−
−	~~Id of the type of service requested.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_referent_id -->==referent_id==~~
−
−	~~Id of the object requested.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_referent_docid -->==referent_docid==~~
−
−	~~Id of the document requested (if relevent).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_methods -->=METHODS=~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==~~
−
−	~~$thing = EPrints::DataObj::Access->get_system_field_info~~
−
−	~~Core fields contained in a Web access.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_constructor_methods -->==Constructor Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new -->===new===~~
−
−	~~$thing = EPrints::DataObj::Access->new( $session, $accessid )~~
−
−	~~The data object identified by $accessid.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new_from_data -->===new_from_data===~~
−
−	~~$thing = EPrints::DataObj::Access->new_from_data( $session, $known )~~
−
−	~~A new <tt>EPrints::DataObj::Access</tt> object containing data $known (a hash reference).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_class_methods -->==Class Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_remove_all -->===remove_all===~~
−
−	~~EPrints::DataObj::Access::remove_all( $session )~~
−
−	~~Remove all records from the license dataset.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_gid -->===get_gid===~~
−
−	~~$dataset = $eprint->get_gid~~
−
−	~~Returns the OAI identifier for this access.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_defaults -->===get_defaults===~~
−
−	~~$defaults = EPrints::DataObj::Access->get_defaults( $session, $data )~~
−
−	~~Return default values for this object based on the starting data.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_object_methods -->==Object Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_remove -->===remove===~~
−
−	~~$foo = $thing->remove()~~
−
−	~~Remove this record from the data set (see [[API:EPrints/Database\|EPrints::Database]]).~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_referent_id -->===get_referent_id===~~
−
−	~~$dataobj->get_referent_id()~~
−
−	~~Return the fully qualified referent id.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_requester_id -->===get_requester_id===~~
−
−	~~$dataobj->get_requester_id()~~
−
−	~~Return the fully qualified requester id.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_see_also -->=SEE ALSO=~~
−	~~[[API:EPrints/DataObj\|EPrints::DataObj]] and [[API:EPrints/DataSet\|EPrints::DataSet]].~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~