NAME

Biber::Section - Biber::Section objects

Initialize a Biber::Section object

citecount

Set the citecount of a key. This comes from biblatex via the
citecounter option and reflects the actual number of citations using
this key, taking into account things like \citeauthor etc. which are not
real citations.

Get the citecount of a key. This comes from biblatex via the
citecounter option and reflects the actual number of citations using
this key, taking into account things like \citeauthor etc. which are not
real citations. A zero or undef value needs to be less than 0 which does
not fail if() checks - required for the delicate sorting dispatch logic

seenkey

Get the count of a key

Increment the seen count of a key

Reset section caches which need it

Check and record max namepart length. Needed to construct sort keys for names

Return max namepart length. Needed to construct sort keys for names

Record a parent->child set relationship

Record a child->parent set relationship

Return a boolean saying if there is a parent->child set relationship

Return a boolean saying if there is a child->parent set relationship

Return a list of children for a parent set

Return a list of parents for a child of a set

Save information about citekey->datasource name mapping. Used for error reporting.

Get information about citekey->datasource name mapping. Used for error reporting.

Returns a value to say if we've seen a key differing only in case before
<previouskey>  - we've seen a differently cased variant of this key so we can warn about this
undef  - Not seen this key at all in any case variant before

Check if a key is specifically cited by \cite{key} or \nocite{key}

Record that a key is used as a related entry

Check if a key is used as a related entry key

Record a key<->clone key mapping.

Fetch a related entry clone key, given a cite key

Fetch a related entry key, given a clone key

Return boolean saying if a cite key has a related entry clone in the current section

Return boolean saying if a related clone key has a citekey in the current section

Adds a key to the list of those that came via \cite

Returns a boolean to say if a key came via \cite

Adds a key to the list of those that came via \nocite

Returns a boolean to say if a key came via \nocite

Adds a datasource key to the section list of all datasource keys

Delete everykey cache. For use in tests.

Returns a boolean to say if we've seen a key in any datasource for this section.
This used to be an array ref which was checked using first() and it
was twenty times slower.

Sets flag to say citekey '*' occurred through \nocite
We allow setting it to false too because it's useful in tests

Sets flag to say citekey '*' occurred in citekeys
We allow setting it to false too because it's useful in tests

Checks flag which says citekey '*' occurred in via \nocite

Checks flag which says citekey '*' occurred in citekeys

Returns a Biber::Entry object for the given citation key
Understands citekey aliases

Return Biber::Entries object for this section

Delete all Biber::Entry objects from the Biber::Section object

Sets the citekeys in a Biber::Section object

Sets the original order of citekeys in a Biber::Section object

Gets the citekeys of a Biber::Section object
Returns a normal array

Gets the citekeys of a Biber::Section object
excluding dynamic set entry keys
Returns a normal array

Returns true when $key was one of the actually cited keys in the section

Adds a citekey to the Biber::Section object as an undefined
key. This allows us to output this information to the .bbl and
so biblatex can do better reporting to external utils like latexmk

Gets the list of undefined citekeys of a Biber::Section object
Returns a normal array

Gets the citekeys of a Biber::Section object in their original order
This is just to ensure we have a method that will return this, just in
case we mess about with the order at some point. This is needed by
citeorder sorting.

Returns true when $key is in the Biber::Section object
Understands key alaises

Deletes a citekey from a Biber::Section object

Deletes all citekeys from a Biber::Section object

Adds citekeys to the Biber::Section object

Set citekey alias information

Get citekey alias information

Delete citekey alias

Get a list of all citekey aliases for the section

Sets the variable label disambiguation cache for a field

Gets the variable label disambiguation cache for a field

Sets the list label disambiguation cache for a field

Gets the list label disambiguation cache for a field

Test if a key is a dynamic set

Record a mapping of dynamic key to member keys

Retrieve member keys for a dynamic set key
Check that reference returning anything to stop spurious warnings
about empty dereference in return.

Retrieve all dynamic set keys

Returns true of false depending on whether the section has any dynamic set keys

Adds a data source to a section

Sets the data sources for a section

Gets an array of data sources for this section

Gets the section number of a Biber::Section object

AUTHORS

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

BUGS

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

COPYRIGHT & LICENSE

Copyright 2009-2012 François Charette and Philip Kime, all rights reserved. Copyright 2012-2023 Philip Kime, all rights reserved.

This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This program 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.