Difference between revisions of "API:EPrints/DataObj/CitationCache"

From EPrints Documentation
Jump to: navigation, search
(Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'...")
 
 
(2 intermediate revisions by the same user not shown)
Line 30: Line 30:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=head_metadata -->
+
<!-- Pod2Wiki=head_core_metadata_fields -->
−
==METADATA==
+
==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%; '>
 
<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 54: Line 54:
 
===datasetid (text)===
 
===datasetid (text)===
  
−
The name of the dataset to which the item that has a citation cache belongs. "eprint" is used for eprints, rather than the inbox, buffer etc.
+
The name of the dataset to which the item that has a citation cache belongs. <tt>eprint</tt> is used for eprints, rather than the <tt>inbox</tt>, <tt>buffer</tt>, etc.
  
 
<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 78: Line 78:
 
===style (text)===
 
===style (text)===
  
−
The style of citation for a particular item. Each DataObj may have nany different citation styles and defined in citations/&lt;DataObject&gt;
+
The style of citation for a particular item. Each data object may have many different citation styles and defined appropriate data  object's sub-directory of the citations configuration directory.
  
 
<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 90: Line 90:
 
===citation_text (text)===
 
===citation_text (text)===
  
−
The actually text generated for the citation cache by render_citation.
+
The actually text generated for the citation cache by [[API:EPrints/DataObj/CitationCache#render_citation|render_citation]].
  
 
<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 103: Line 103:
  
 
The moment at which this citation cache was generated.
 
The moment at which this citation cache was generated.
 +
 +
<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_references_and_related_objects -->
 +
==REFERENCES AND RELATED OBJECTS==
 +
None.
 +
 +
<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_instance_variables -->
 +
==INSTANCE VARIABLES==
 +
See &lt;EPrints::DataObj|EPrints::DataObj#INSTANCE_VARIABLES&gt;.
  
 
<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 113: Line 135:
 
<!-- Pod2Wiki=head_methods -->
 
<!-- Pod2Wiki=head_methods -->
 
==METHODS==
 
==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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_constructor_methods -->
 +
===Constructor 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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_create -->
 +
====create====
 +
 +
EPrints::DataObj::CitationCache::create( $session, $data );
 +
Create a new citationcache object from supplied <tt>$data</tt>. Unlike other create methods this one does not return the new object as it's never needed, and would increase the load on modifying items.
 +
 +
Also, this does not queue the fields for indexing.
 +
 +
<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_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 121: Line 176:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_system_field_info -->
 
<!-- Pod2Wiki=item_get_system_field_info -->
−
===get_system_field_info===
+
====get_system_field_info====
  
 
  $field_info = EPrints::DataObj::CitationCache-&gt;get_system_field_info
 
  $field_info = EPrints::DataObj::CitationCache-&gt;get_system_field_info
Line 134: Line 189:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_dataset_id -->
 
<!-- Pod2Wiki=item_get_dataset_id -->
−
===get_dataset_id===
+
====get_dataset_id====
  
 
  $dataset = EPrints::DataObj::CitationCache-&gt;get_dataset_id
 
  $dataset = EPrints::DataObj::CitationCache-&gt;get_dataset_id
Line 146: Line 201:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_commit -->
+
<!-- Pod2Wiki=item_get_defaults -->
−
===commit===
+
====get_defaults====
  
−
  $citationcache-&gt;commit
+
  $defaults = EPrints::DataObj::CitationCache-&gt;get_defaults( $session, $data )
−
Commit the formatted text generated for a citationcache
+
Return default values for this object based on the starting <tt>$data</tt>.
  
 
<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 214:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_create -->
+
<!-- Pod2Wiki=head_object_methods -->
−
===create===
+
===Object Methods===
−
 
 
−
EPrints::DataObj::CitationCache::create( $session, $data );
 
−
Create a new citationcache object from supplied <tt>$data</tt>. Unlike other  create methods this one does not return the new object as it's never  needed, and would increase the load on modifying items.
 
−
 
−
Also, this does not queue the fields for indexing.
 
−
 
 
<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 174: Line 223:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
−
<!-- Pod2Wiki=item_get_defaults -->
+
<!-- Pod2Wiki=item_commit -->
−
===get_defaults===
+
====commit====
  
−
  $defaults = EPrints::DataObj::CitationCache-&gt;get_defaults( $session, $data )
+
  $citationcache-&gt;commit
−
Return default values for this object based on the starting <tt>$data</tt>.
+
Commit the formatted text generated for a citationcache
  
 
<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 188: Line 237:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_render -->
 
<!-- Pod2Wiki=item_render -->
−
===render===
+
====render====
  
 
  $xhtml = $citationcache-&gt;render
 
  $xhtml = $citationcache-&gt;render
−
A citationcache cannot have a rendering of itself.
+
A citation cache cannot have a rendering of itself.
  
 
<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 201: Line 250:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_dataobj -->
 
<!-- Pod2Wiki=item_get_dataobj -->
−
===get_dataobj===
+
====get_dataobj====
 +
 
 +
$dataobj = $citationcache-&gt;get_dataobj
 +
Returns the object to which this citation cache relates.
 +
 
 +
<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 -->
 +
 
  
−
$object = $citationcache-&gt;get_dataobj
+
<!-- Pod2Wiki= -->
−
Returns the object to which this citationcache relates.
+
</div>
 +
<!-- Pod2Wiki=head_see_also -->
 +
==SEE ALSO==
 +
[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::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%; '>

Latest revision as of 16:37, 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

API: Core API

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


NAME

EPrints::DataObj::CitationCache - A cached citation for a data object.

User Comments


DESCRIPTION

This class describes a single item in the citationcache dataset. A citationcache object describes a formatted citation for a single item in another dataset.

To enable citation caching edit the archive's cfg/cfg.d/citationcaches.pl and change the appropriate line to: 

$c->{citation_caching}->{enabled} = 1;

User Comments


CORE METADATA FIELDS

User Comments


citationcacheid (int)

The unique numerical ID of this citation cache event.

User Comments


datasetid (text)

The name of the dataset to which the item that has a citation cache belongs. eprint is used for eprints, rather than the inbox, buffer, etc.

User Comments


objectid (int)

The numerical ID of the object in the dataset.

User Comments


style (text)

The style of citation for a particular item. Each data object may have many different citation styles and defined appropriate data object's sub-directory of the citations configuration directory.

User Comments


citation_text (text)

The actually text generated for the citation cache by render_citation.

User Comments


timestamp (time)

The moment at which this citation cache was generated.

User Comments


REFERENCES AND RELATED OBJECTS

None.

User Comments


INSTANCE VARIABLES

See <EPrints::DataObj|EPrints::DataObj#INSTANCE_VARIABLES>.

User Comments


METHODS

User Comments


Constructor Methods

User Comments


create

EPrints::DataObj::CitationCache::create( $session, $data );

Create a new citationcache object from supplied $data. Unlike other create methods this one does not return the new object as it's never needed, and would increase the load on modifying items.

Also, this does not queue the fields for indexing.

User Comments


Class Methods

User Comments


get_system_field_info

$field_info = EPrints::DataObj::CitationCache->get_system_field_info

Return the metadata field configuration for this object.

User Comments


get_dataset_id

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

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

User Comments


get_defaults

$defaults = EPrints::DataObj::CitationCache->get_defaults( $session, $data )

Return default values for this object based on the starting $data.

User Comments


Object Methods

User Comments


commit

$citationcache->commit

Commit the formatted text generated for a citationcache

User Comments


render

$xhtml = $citationcache->render

A citation cache cannot have a rendering of itself.

User Comments


get_dataobj

$dataobj = $citationcache->get_dataobj

Returns the object to which this citation cache relates.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


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/.

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/DataObj/CitationCache&oldid=14155’