Difference between revisions of "API:EPrints/DataObj/Access"
| Line 177: | Line 177: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=head_class_methods --> |
| − | === | + | ===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%; '> | <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> | <span style='display:none'>User Comments</span> | ||
| Line 190: | Line 186: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_get_system_field_info --> |
| − | === | + | ====get_system_field_info==== |
| + | |||
| + | $fields = EPrints::DataObj::Access->get_system_field_info | ||
| + | Returns an array describing the system metadata of the access 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%; '> | ||
<span style='display:none'>User Comments</span> | <span style='display:none'>User Comments</span> | ||
| Line 224: | Line 224: | ||
====get_referent_id==== | ====get_referent_id==== | ||
| − | $ | + | $referent_id = $access->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%; '> | <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==== | ====get_requester_id==== | ||
| − | $ | + | $requester_id = $access->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%; '> | <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:26, 1 January 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::DataObj::Access - Accesses to the Web server
DESCRIPTION
Accesses to particular abstract/summary pages (views) or publication documents (downloads).
Inherits from EPrints::DataObj.
INSTANCE VARIABLES
See EPrints::DataObj/INSTANCE_VARIABLES.
CORE METADATA FIELDS
accessid (counter)
Unique ID for the access.
datestamp (timestamp)
Time of access.
requester_id (text)
ID of the requesting user-agent. (Typically an IP address).
requester_user_agent (text)
The HTTP user agent string. (Useful for robots spotting).
requester_country (text)
The country from which the request originated. (Typically determined using Geo::IP).
requester_institution (text)
The institution from which the request originated. (This could be used to store the Net-Name from a WHOIS lookup).
referring_entity_id (longtext)
ID of the object from which the user agent came from (i.e. HTTP referrer).
service_type_id (text)
Id of the type of service requested. (E.g. abstract view or full text download).
referent_id (int)
ID of the object requested. (Normally the eprint ID).
referent_docid (int)
ID of the document requested (if relevant).
METHODS
Class Methods
get_system_field_info
$fields = EPrints::DataObj::Access->get_system_field_info
Returns an array describing the system metadata of the access dataset.
get_dataset_id
$dataset = EPrints::DataObj::Access->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
Object Methods
get_referent_id
$referent_id = $access->get_referent_id
Returns the fully-qualified referent ID.
get_requester_id
$requester_id = $access->get_requester_id
Return the fully-qualified requester ID.
SEE ALSO
EPrints::DataObj and EPrints::DataSet.
COPYRIGHT
© Copyright 2023 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/.
