1Biber::Entry(3pm)     User Contributed Perl Documentation    Biber::Entry(3pm)
2
3
4

NAME

6       Biber::Entry - Biber::Entry objects
7
8   new
9           Initialize a Biber::Entry object
10
11           There are three types of field possible in an entry:
12
13           * data    - These are fields which derive directly from or are themselves fields in the
14                       data source. Things like YEAR, MONTH, DAY etc. are such fields which are
15                       derived from, for example, the DATE field. They are part of the original
16                       data implicitly, derived from a field.
17           * derived - These are fields, often meta-information like labelname, labelalpha etc.
18                       which are more removed from the data fields.
19
20           The reason for this division is largely the entry cloning required for the related entry and
21           inheritance features. When we clone an entry or copy some fields from one entry to another
22           we generally don't want the "derived" category as such derived meta-fields will often need
23           to be re-created or ignored so we need to know which are the actual "data" fields to
24           copy/clone.
25
26   relclone
27           Recursively create related entry clones starting with an entry
28
29   clone
30           Clone a Biber::Entry object and return a copy
31           Accepts optionally a key for the copy
32
33   notnull
34           Test for an empty object
35
36   add_xdata_ref
37         Add an XDATA reference to the entry
38         Reference can be simply to an entire XDATA entry or a particular field+position in field
39         Record reference and target positions so that the XDATA marker can be removed as otherwise
40         it would break further parsing
41
42   get_xdata_refs
43         Get the XDATA references
44
45   get_xdata_ref
46         Get a specific XDATA reference
47
48   is_xdata_resolved
49         Checks if an XDATA reference was resolved. Returns false also for
50         "no such reference".
51
52   set_labelname_info
53         Record the labelname information. This is special
54         meta-information so we have a separate method for this
55         Takes a hash ref with the information.
56
57   get_labelname_info
58         Retrieve the labelname information. This is special
59         meta-information so we have a separate method for this
60         Returns a hash ref with the information.
61
62   set_labelnamefh_info
63         Record the fullhash labelname information. This is special
64         meta-information so we have a separate method for this
65         Takes a hash ref with the information.
66
67   get_labelnamefh_info
68         Retrieve the fullhash labelname information. This is special
69         meta-information so we have a separate method for this
70         Returns a hash ref with the information.
71
72   set_labeltitle_info
73         Record the labeltitle information. This is special
74         meta-information so we have a separate method for this
75         Takes a hash ref with the information.
76
77   get_labeltitle_info
78         Retrieve the labeltitle information. This is special
79         meta-information so we have a separate method for this
80         Returns a hash ref with the information.
81
82   set_labeldate_info
83         Record the labeldate information. This is special
84         meta-information so we have a separate method for this
85         Takes a hash ref with the information.
86
87   get_labeldate_info
88         Retrieve the labeldate information. This is special
89         meta-information so we have a separate method for this
90         Returns a hash ref with the information.
91
92   set_field
93         Set a derived field for a Biber::Entry object, that is, a field
94         which was not an actual bibliography field
95
96   get_field
97           Get a field for a Biber::Entry object
98           Uses // as fields can be null (end dates etc).
99
100   set_datafield
101           Set a field which is in the .bib data file
102
103   get_datafield
104           Get a field that was in the original data file
105
106   del_field
107           Delete a field in a Biber::Entry object
108
109   del_datafield
110           Delete an original data source data field in a Biber::Entry object
111
112   field_exists
113           Check whether a field exists (even if null)
114
115   date_fields_exist
116           Check whether any parts of a date field exist when passed a datepart field name
117
118   delete_date_fields
119           Delete all parts of a date field when passed any datepart field name
120
121   datafields
122           Returns a sorted array of the fields which came from the data source
123
124   count_datafields
125           Returns the number of datafields
126
127   derivedfields
128           Returns a sorted array of the fields which were added during processing
129
130   fields
131           Returns a sorted array of all field names, including ones
132           added during processing which are not necessarily fields
133           which came from the data file
134
135   count_fields
136           Returns the number of fields
137
138   has_keyword
139           Check if a Biber::Entry object has a particular keyword in
140           in the KEYWORDS field.
141
142   add_warning
143           Append a warning to a Biber::Entry object
144
145   set_inherit_from
146           Inherit fields from first child entry
147
148           $entry->set_inherit_from($firstchild);
149
150           Takes a second Biber::Entry object as argument
151
152           The purpose here is to inherit fields so that sorting/labelling defaults
153           can be generated for set parents from the first child set member data, unless
154           the set parent itself already has some fields set that will do this. Set
155           parents only have certain fields output in the .bbl and those that output but
156           are not used in sorting/labelling data generation should not be inherited.
157
158   resolve_xdata
159           Recursively resolve XDATA in an entry. Sets a flag in the XDATA metadata to
160           say if the reference was successfully resolved.
161
162           $entry->resolve_xdata($xdata);
163
164   inherit_from
165           Inherit fields from parent entry (as indicated by the crossref field)
166
167           $entry->inherit_from($parententry);
168
169           Takes a second Biber::Entry object as argument
170           Uses the crossref inheritance specifications from the .bcf
171
172   dump
173           Dump Biber::Entry object
174

AUTHORS

176       Philip Kime "<philip at kime.org.uk>"
177

BUGS

179       Please report any bugs or feature requests on our Github tracker at
180       <https://github.com/plk/biber/issues>.
181
183       Copyright 2009-2012 François Charette and Philip Kime, all rights
184       reserved.  Copyright 2012-2023 Philip Kime, all rights reserved.
185
186       This module is free software.  You can redistribute it and/or modify it
187       under the terms of the Artistic License 2.0.
188
189       This program is distributed in the hope that it will be useful, but
190       without any warranty; without even the implied warranty of
191       merchantability or fitness for a particular purpose.
192
193
194
195perl v5.38.0                      2023-07-19                 Biber::Entry(3pm)
Impressum