<<

NAME

Koha::Library - Koha Library Object class

API

Class methods

store

Library specific store to ensure relevant caches are flushed on change

delete

Library specific delete to clear relevant caches on delete.

stockrotationstages

  my $stages = Koha::Library->stockrotationstages;

Returns the stockrotation stages associated with this Library.

outgoing_transfers

  my $outgoing_transfers = Koha::Library->outgoing_transfers;

Returns the outgoing item transfers associated with this Library.

inbound_transfers

  my $inbound_transfers = Koha::Library->inbound_transfers;

Returns the inbound item transfers associated with this Library.

get_effective_marcorgcode

    my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();

Returns the effective MARC organization code of the library. It falls back to the value from the MARCOrgCode syspref if undefined for the library.

smtp_server

    my $smtp_server = $library->smtp_server;
    $library->smtp_server({ smtp_server => $smtp_server });
    $library->smtp_server({ smtp_server => undef });

Accessor for getting and setting the library's SMTP server.

Returns the effective SMTP server configuration to be used on the library. The returned value is always a Koha::SMTP::Server object.

Setting it to undef will remove the link to a specific SMTP server and effectively make the library use the default setting

from_email_address

  my $from_email = Koha::Library->from_email_address;

Returns the official 'from' email address for the branch.

It may well be a 'noreply' or other inaccessible local domain address that is being used to satisfy spam protection filters.

inbound_email_address

  my $to_email = Koha::Library->inbound_email_address;

Returns an effective email address which should be accessible to librarians at the branch.

NOTE: This is the address to use for 'reply_to' or 'to' fields; It should not usually be used as the 'from' address for emails as it may lead to mail being caught by spam filters.

inbound_ill_address

  my $to_email = Koha::Library->inbound_ill_address;

Returns an effective email address which should be accessible to librarians at the branch for inter library loans communication.

library_groups

Return the Library groups of this library

cash_registers

Return Cash::Registers associated with this Library

desks

    my $desks = $library->desks;

Returns Koha::Desks associated with this library.

get_hold_libraries

Return all libraries (including self) that belong to the same hold groups

validate_hold_sibling

Return if given library is a valid hold group member

public_read_list

This method returns the list of publicly readable database fields for both API and UI output purposes

to_api_mapping

This method returns the mapping for representing a Koha::Library object on the API.

opac_info

    $library->opac_info({ lang => $lang });

Returns additional contents block OpacLibraryInfo for $lang or 'default'.

Note: This replaces the former branches.opac_info column.

get_float_libraries

Return all libraries belonging to the same float group

validate_float_sibling

Return if given library is a valid float group member

library_hours

Returns the open and close times for a library.

Internal methods

_type

<<