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 =head3 get_effective_marcorgcode
  45
  46     my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
  47
  48 Returns the effective MARC organization code of the library. It falls back to the value
  49 from the I<MARCOrgCode> syspref if undefined for the library.
  50
  51 =cut
  52
  53 sub get_effective_marcorgcode {
  54     my ( $self )  = @_;
  55
  56     return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
  57 }
  58
  59 =head3 library_groups
  60
  61 Return the Library groups of this library
  62
  63 =cut
  64
  65 sub library_groups {
  66     my ( $self ) = @_;
  67     my $rs = $self->_result->library_groups;
  68     return Koha::Library::Groups->_new_from_dbic( $rs );
  69 }
  70
  71 =head2 Internal methods
  72
  73 =head3 _type
  74
  75 =cut
  76
  77 sub _type {
  78     return 'Branch';
  79 }
  80
  81 1;