API:EPrints/DataObj/Request: Difference between revisions
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
==NAME== | ==NAME== | ||
'''EPrints::DataObj::Request''' - | '''EPrints::DataObj::Request''' - User requests. | ||
<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> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=head_description --> | |||
==DESCRIPTION== | |||
This class stores user requests and their responses for requesting a copy of a document. | |||
<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%; '> | ||
Latest revision as of 11:07, 10 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
NAME[edit]
EPrints::DataObj::Request - User requests.
DESCRIPTION[edit]
This class stores user requests and their responses for requesting a copy of a document.
CORE METADATA FIELDS[edit]
requestid (counter)[edit]
The unique identifier for this request
docid (text)[edit]
The ID for any document this request may relate.
datestamp (timestamp)[edit]
The datestamp this request was created.
email (email)[edit]
The email address to which this request is sent.
requester_email (email)[edit]
The email address of the requester.
reason (longtext)[edit]
The reason the request was made.
expiry_date (time)[edit]
The time at which this request will expires.
code (text)[edit]
The code for this request, which can be used to created private URLS.
captcha (recaptcha)[edit]
The ReCAPTCHA field for the form for this request.
REFERENCES AND RELATED OBJECTS[edit]
eprintid (itemref)[edit]
The ID of the eprint data object associated with this request.
userid (itemref)[edit]
The ID of the user to whom this request is assigned.
INSTANCES VARIABLES[edit]
See EPrints::DataObj.
METHODS[edit]
Class Methods[edit]
get_system_field_info[edit]
$fields = EPrints::DataObj::Request->get_system_field_info
Returns an array describing the system metadata of the request dataset.
get_dataset_id[edit]
$dataset = EPrints::DataObj::Request->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
new_from_code[edit]
$request = EPrints::DataObj::Request->new_from_code( $session, $code )
Returns request that matches provided $code.
Object Methods[edit]
has_expired[edit]
$boolean = $request->has_expired
Returns a boolean depending on whether this request has expired.
SEE ALSO[edit]
EPrints::DataObj and EPrints::DataSet.
COPYRIGHT[edit]
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE[edit]
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/.