Koha/Library.pm

   1 package Koha::Library;
   2
   3 # Copyright 2015 Koha Development team
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 3 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use C4::Context;
  25
  26 use Koha::Database;
  27
  28 use base qw(Koha::Object);
  29
  30 =head1 NAME
  31
  32 Koha::Library - Koha Library Object class
  33
  34 =head1 API
  35
  36 =head2 Class methods
  37
  38 =head3 get_categories
  39
  40 TODO: Ask the author to add a proper description
  41
  42 =cut
  43
  44 sub get_categories {
  45     my ( $self, $params ) = @_;
  46     # TODO This should return Koha::LibraryCategories
  47     return $self->{_result}->categorycodes( $params );
  48 }
  49
  50 =head3 update_categories
  51
  52 TODO: Ask the author to add a proper description
  53
  54 =cut
  55
  56 sub update_categories {
  57     my ( $self, $categories ) = @_;
  58     $self->_result->delete_related( 'branchrelations' );
  59     $self->add_to_categories( $categories );
  60 }
  61
  62 =head3 add_to_categories
  63
  64 TODO: Ask the author to add a proper description
  65
  66 =cut
  67
  68 sub add_to_categories {
  69     my ( $self, $categories ) = @_;
  70     for my $category ( @$categories ) {
  71         $self->_result->add_to_categorycodes( $category->_result );
  72     }
  73 }
  74
  75 =head3 get_effective_marcorgcode
  76
  77     my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
  78
  79 Returns the effective MARC organization code of the library. It falls back to the value
  80 from the I<MARCOrgCode> syspref if undefined for the library.
  81
  82 =cut
  83
  84 sub get_effective_marcorgcode {
  85     my ( $self )  = @_;
  86
  87     return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
  88 }
  89
  90 =head2 Internal methods
  91
  92 =head3 _type
  93
  94 =cut
  95
  96 sub _type {
  97     return 'Branch';
  98 }
  99
 100 1;