Biber::Section(3)

NAME
Biber::Section

  new
    Initialize a Biber::Section object

  reset_caches
    Reset section caches which need it

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

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

  has_badcasekey
    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

  add_related
    Record that a key is used as a related entry

  is_related
    Check if a key is used as a related entry key

  keytorelclone
    Record a key<->clone key mapping.

  get_keytorelclone
    Fetch a related entry clone key, given a cite key

  get_relclonetokey
    Fetch a related entry key, given a clone key

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

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

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

  del_everykeys
  Delete everykey cache. For use in tests.

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

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

  is_allkeys
    Checks flag which says citekey '*' occurred in citekeys

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

  bibentries
    Return Biber::Entries object for this section

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

  set_citekeys
    Sets the citekeys in a Biber::Section object

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

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

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

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

  add_undef_citekey
    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

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

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

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

  del_citekey
    Deletes a citekey from a Biber::Section object

  del_citekeys
    Deletes all citekeys from a Biber::Section object

  add_citekeys
    Adds citekeys to the Biber::Section object

  set_citekey_alias
    Set citekey alias information

  get_citekey_alias
    Get citekey alias information

  del_citekey_alias
    Delete citekey alias

  get_citekey_aliases
    Get a list of all citekey aliases for the section

  set_labelcache_v
    Sets the variable label disambiguation cache for a field

  get_labelcache_v
    Gets the variable label disambiguation cache for a field

  set_labelcache_l
    Sets the list label disambiguation cache for a field

  get_labelcache_l
    Gets the list label disambiguation cache for a field

  is_dynamic_set
    Test if a key is a dynamic set

  set_dynamic_set
    Record a mapping of dynamic key to member keys

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

  dynamic_set_keys
    Retrieve all dynamic set keys

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

  add_datasource
    Adds a data source to a section

  set_datasources
    Sets the data sources for a section

  get_datasources
    Gets an array of data sources for this section

  number
    Gets the section number of a Biber::Section object

AUTHORS
Francois Charette, "<firmicus at ankabut.net>" 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-2018 Francois Charette and 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.