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

NAME

6       Biber::Entry
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   set_labelname_info
37         Record the labelname information. This is special
38         meta-information so we have a separate method for this
39         Takes a hash ref with the information.
40
41   get_labelname_info
42         Retrieve the labelname information. This is special
43         meta-information so we have a separate method for this
44         Returns a hash ref with the information.
45
46   set_labelnamefh_info
47         Record the fullhash labelname information. This is special
48         meta-information so we have a separate method for this
49         Takes a hash ref with the information.
50
51   get_labelnamefh_info
52         Retrieve the fullhash labelname information. This is special
53         meta-information so we have a separate method for this
54         Returns a hash ref with the information.
55
56   set_labeltitle_info
57         Record the labeltitle information. This is special
58         meta-information so we have a separate method for this
59         Takes a hash ref with the information.
60
61   get_labeltitle_info
62         Retrieve the labeltitle information. This is special
63         meta-information so we have a separate method for this
64         Returns a hash ref with the information.
65
66   set_labeldate_info
67         Record the labeldate information. This is special
68         meta-information so we have a separate method for this
69         Takes a hash ref with the information.
70
71   get_labeldate_info
72         Retrieve the labeldate information. This is special
73         meta-information so we have a separate method for this
74         Returns a hash ref with the information.
75
76   set_field
77         Set a derived field for a Biber::Entry object, that is, a field
78         which was not an actual bibliography field
79
80   get_field
81           Get a field for a Biber::Entry object
82           Uses // as fields can be null (end dates etc).
83
84   set_datafield
85           Set a field which is in the .bib data file
86
87   get_datafield
88           Get a field that was in the original data file
89
90   del_field
91           Delete a field in a Biber::Entry object
92
93   del_datafield
94           Delete an original data source data field in a Biber::Entry object
95
96   field_exists
97           Check whether a field exists (even if null)
98
99   date_fields_exist
100           Check whether any parts of a date field exist when passed a datepart field name
101
102   datafields
103           Returns a sorted array of the fields which came from the data source
104
105   count_datafields
106           Returns the number of datafields
107
108   derivedfields
109           Returns a sorted array of the fields which were added during processing
110
111   fields
112           Returns a sorted array of all field names, including ones
113           added during processing which are not necessarily fields
114           which came from the data file
115
116   count_fields
117           Returns the number of fields
118
119   has_keyword
120           Check if a Biber::Entry object has a particular keyword in
121           in the KEYWORDS field.
122
123   add_warning
124           Append a warning to a Biber::Entry object
125
126   set_inherit_from
127           Inherit fields from first child entry
128
129           $entry->set_inherit_from($firstchild);
130
131           Takes a second Biber::Entry object as argument
132
133           The purpose here is to inherit fields so that sorting/labelling defaults
134           can be generated for set parents from the first child set member data, unless
135           the set parent itself already has some fields set that will do this. Set
136           parents only have certain fields output in the .bbl and those that output but
137           are not used in sorting/labelling data generation should not be inherited.
138
139   resolve_xdata
140           Recursively resolve XDATA fields in an entry
141
142           $entry->resolve_xdata($xdata_entry);
143
144   inherit_from
145           Inherit fields from parent entry (as indicated by the crossref field)
146
147           $entry->inherit_from($parententry);
148
149           Takes a second Biber::Entry object as argument
150           Uses the crossref inheritance specifications from the .bcf
151
152   dump
153           Dump Biber::Entry object
154

AUTHORS

156       Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at
157       kime.org.uk>"
158

BUGS

160       Please report any bugs or feature requests on our Github tracker at
161       <https://github.com/plk/biber/issues>.
162
164       Copyright 2009-2018 Francois Charette and Philip Kime, all rights
165       reserved.
166
167       This module is free software.  You can redistribute it and/or modify it
168       under the terms of the Artistic License 2.0.
169
170       This program is distributed in the hope that it will be useful, but
171       without any warranty; without even the implied warranty of
172       merchantability or fitness for a particular purpose.
173
174
175
176perl v5.30.0                      2019-11-17                   Biber::Entry(3)
Impressum