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

NAME

6       Biber::Section
7
8   new
9           Initialize a Biber::Section object
10
11   reset_caches
12           Reset section caches which need it
13
14   set_keytods
15         Save information about citekey->datasource name mapping. Used for error reporting.
16
17   get_keytods
18         Get information about citekey->datasource name mapping. Used for error reporting.
19
20   has_badcasekey
21           Returns a value to say if we've seen a key differing only in case before
22           <previouskey>  - we've seen a differently cased variant of this key so we can warn about this
23           undef  - Not seen this key at all in any case variant before
24
25   add_related
26           Record that a key is used as a related entry
27
28   is_related
29           Check if a key is used as a related entry key
30
31   keytorelclone
32           Record a key<->clone key mapping.
33
34   get_keytorelclone
35           Fetch a related entry clone key, given a cite key
36
37   get_relclonetokey
38           Fetch a related entry key, given a clone key
39
40   has_keytorelclone
41           Return boolean saying if a cite key has a related entry clone in the current section
42
43   has_relclonetokey
44           Return boolean saying if a related clone key has a citekey in the current section
45
46   add_everykey
47           Adds a datasource key to the section list of all datasource keys
48
49   del_everykeys
50         Delete everykey cache. For use in tests.
51
52   has_everykey
53           Returns a boolean to say if we've seen a key in any datasource for this section.
54           This used to be an array ref which was checked using first() and it
55           was twenty times slower.
56
57   set_allkeys
58           Sets flag to say citekey '*' occurred in citekeys
59           We allow setting it to false too because it's useful in tests
60
61   is_allkeys
62           Checks flag which says citekey '*' occurred in citekeys
63
64   bibentry
65           Returns a Biber::Entry object for the given citation key
66           Understands citekey aliases
67
68   bibentries
69           Return Biber::Entries object for this section
70
71   del_bibentries
72           Delete all Biber::Entry objects from the Biber::Section object
73
74   set_citekeys
75           Sets the citekeys in a Biber::Section object
76
77   set_orig_order_citekeys
78           Sets the original order of citekeys in a Biber::Section object
79
80   get_citekeys
81           Gets the citekeys of a Biber::Section object
82           Returns a normal array
83
84   get_static_citekeys
85           Gets the citekeys of a Biber::Section object
86           excluding dynamic set entry keys
87           Returns a normal array
88
89   has_cited_citekey
90           Returns true when $key was one of the actually cited keys in the section
91
92   add_undef_citekey
93           Adds a citekey to the Biber::Section object as an undefined
94           key. This allows us to output this information to the .bbl and
95           so biblatex can do better reporting to external utils like latexmk
96
97   get_undef_citekeys
98           Gets the list of undefined citekeys of a Biber::Section object
99           Returns a normal array
100
101   get_orig_order_citekeys
102           Gets the citekeys of a Biber::Section object in their original order
103           This is just to ensure we have a method that will return this, just in
104           case we mess about with the order at some point. This is needed by
105           citeorder sorting.
106
107   has_citekey
108           Returns true when $key is in the Biber::Section object
109           Understands key alaises
110
111   del_citekey
112           Deletes a citekey from a Biber::Section object
113
114   del_citekeys
115           Deletes all citekeys from a Biber::Section object
116
117   add_citekeys
118           Adds citekeys to the Biber::Section object
119
120   set_citekey_alias
121           Set citekey alias information
122
123   get_citekey_alias
124           Get citekey alias information
125
126   del_citekey_alias
127           Delete citekey alias
128
129   get_citekey_aliases
130           Get a list of all citekey aliases for the section
131
132   set_labelcache_v
133           Sets the variable label disambiguation cache for a field
134
135   get_labelcache_v
136           Gets the variable label disambiguation cache for a field
137
138   set_labelcache_l
139           Sets the list label disambiguation cache for a field
140
141   get_labelcache_l
142           Gets the list label disambiguation cache for a field
143
144   is_dynamic_set
145           Test if a key is a dynamic set
146
147   set_dynamic_set
148           Record a mapping of dynamic key to member keys
149
150   get_dynamic_set
151           Retrieve member keys for a dynamic set key
152           Check that reference returning anything to stop spurious warnings
153           about empty dereference in return.
154
155   dynamic_set_keys
156           Retrieve all dynamic set keys
157
158   has_dynamic_sets
159           Returns true of false depending on whether the section has any dynamic set keys
160
161   add_datasource
162           Adds a data source to a section
163
164   set_datasources
165           Sets the data sources for a section
166
167   get_datasources
168           Gets an array of data sources for this section
169
170   number
171           Gets the section number of a Biber::Section object
172

AUTHORS

174       Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at
175       kime.org.uk>"
176

BUGS

178       Please report any bugs or feature requests on our Github tracker at
179       <https://github.com/plk/biber/issues>.
180

COPYRIGHT & LICENSE

182       Copyright 2009-2018 Francois Charette and Philip Kime, all rights
183       reserved.
184
185       This module is free software.  You can redistribute it and/or modify it
186       under the terms of the Artistic License 2.0.
187
188       This program is distributed in the hope that it will be useful, but
189       without any warranty; without even the implied warranty of
190       merchantability or fitness for a particular purpose.
191
192
193
194perl v5.28.0                      2018-10-18                 Biber::Section(3)