⧼vector-jumptocontent⧽

API:EPrints/DataObj/Access: Difference between revisions

From EPrints Documentation
← Older editNewer edit →
Pod2wiki (talk | contribs)
291 edits
No edit summary
Pod2wiki (talk | contribs)
291 edits
No edit summary
Line 17: Line 17:
<!-- Pod2Wiki=head_description -->
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
==DESCRIPTION==
Accesses to particular abstract/summary pages (views) or publication  documents (downloads).
Inherits from [[API:EPrints/DataObj|EPrints::DataObj]].
Inherits from [[API:EPrints/DataObj|EPrints::DataObj]].


Line 35: Line 37:
<!-- Pod2Wiki= -->
<!-- Pod2Wiki= -->
</div>
</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%; '>
<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= -->
<!-- Pod2Wiki= -->
</div>
</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%; '>
<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= -->
<!-- Pod2Wiki= -->
</div>
</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%; '>
<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>
</div>
<!-- Pod2Wiki=item_accessid -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_datestamp -->
<!-- Pod2Wiki=item_datestamp -->
===datestamp===
===datestamp (timestamp)===


Time of access.
Time of access.
Line 99: Line 101:
</div>
</div>
<!-- Pod2Wiki=item_requester_id -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_requester_user_agent -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_requester_country -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_requester_institution -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_referring_entity_id -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_service_type_id -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_referent_id -->
<!-- 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%; '>
<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>
</div>
<!-- Pod2Wiki=item_referent_docid -->
<!-- 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%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Revision as of 22:05, 1 January 2022

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


NAME

EPrints::DataObj::Access - Accesses to the Web server

User Comments


DESCRIPTION

Accesses to particular abstract/summary pages (views) or publication documents (downloads).

Inherits from EPrints::DataObj.

User Comments


INSTANCE VARIABLES

User Comments


$access->{ "data" }

User Comments


$access->{ "dataset" }

User Comments


$access->{ "session" }

User Comments


CORE METADATA FIELDS

User Comments


accessid (counter)

Unique ID for the access.

User Comments


datestamp (timestamp)

Time of access.

User Comments


requester_id (text)

ID of the requesting user-agent. (Typically an IP address).

User Comments


requester_user_agent (text)

The HTTP user agent string. (Useful for robots spotting).

User Comments


requester_country (text)

The country from which the request originated. (Typically determined using Geo::IP).

User Comments


requester_institution (text)

The institution from which the request originated. (This could be used to store the Net-Name from a WHOIS lookup).

User Comments


referring_entity_id (longtext)

ID of the object from which the user agent came from (i.e. HTTP referrer).

User Comments


service_type_id (text)

Id of the type of service requested. (E.g. abstract view or full text download).

User Comments


referent_id (int)

ID of the object requested. (Normally the eprint ID).

User Comments


referent_docid (int)

ID of the document requested (if relevant).

User Comments


METHODS

User Comments


get_system_field_info

$thing = EPrints::DataObj::Access->get_system_field_info

Core fields contained in a Web access.

User Comments


Class Methods

User Comments


get_dataset_id

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

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

User Comments


Object Methods

User Comments


get_referent_id

$dataobj->get_referent_id()

Returns the fully qualified referent ID.

User Comments


get_requester_id

$dataobj->get_requester_id

Return the fully qualified requester ID.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

© Copyright 2000-2024 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


Retrieved from "https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API:EPrints/DataObj/Access&oldid=14055"