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
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use C4::Context;
  25
  26 use Koha::Database;
  27 use Koha::StockRotationStages;
  28
  29 use base qw(Koha::Object);
  30
  31 =head1 NAME
  32
  33 Koha::Library - Koha Library Object class
  34
  35 =head1 API
  36
  37 =head2 Class methods
  38
  39 =head3 stockrotationstages
  40
  41   my $stages = Koha::Library->stockrotationstages;
  42
  43 Returns the stockrotation stages associated with this Library.
  44
  45 =cut
  46
  47 sub stockrotationstages {
  48     my ( $self ) = @_;
  49     my $rs = $self->_result->stockrotationstages;
  50     return Koha::StockRotationStages->_new_from_dbic( $rs );
  51 }
  52
  53 =head3 get_effective_marcorgcode
  54
  55     my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
  56
  57 Returns the effective MARC organization code of the library. It falls back to the value
  58 from the I<MARCOrgCode> syspref if undefined for the library.
  59
  60 =cut
  61
  62 sub get_effective_marcorgcode {
  63     my ( $self )  = @_;
  64
  65     return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
  66 }
  67
  68 =head3 inbound_email_address
  69
  70   my $to_email = Koha::Library->inbound_email_address;
  71
  72 Returns an effective email address which should be accessible to librarians at the branch.
  73
  74 =cut
  75
  76 sub inbound_email_address {
  77     my ($self) = @_;
  78
  79     return
  80          $self->branchreplyto
  81       || $self->branchemail
  82       || C4::Context->preference('ReplytoDefault')
  83       || C4::Context->preference('KohaAdminEmailAddress')
  84       || undef;
  85 }
  86
  87 =head3 library_groups
  88
  89 Return the Library groups of this library
  90
  91 =cut
  92
  93 sub library_groups {
  94     my ( $self ) = @_;
  95     my $rs = $self->_result->library_groups;
  96     return Koha::Library::Groups->_new_from_dbic( $rs );
  97 }
  98
  99 =head3 cash_registers
 100
 101 Return Cash::Registers associated with this Library
 102
 103 =cut
 104
 105 sub cash_registers {
 106     my ( $self ) = @_;
 107     my $rs = $self->_result->cash_registers;
 108     return Koha::Cash::Registers->_new_from_dbic( $rs );
 109 }
 110
 111 =head3 to_api_mapping
 112
 113 This method returns the mapping for representing a Koha::Library object
 114 on the API.
 115
 116 =cut
 117
 118 sub to_api_mapping {
 119     return {
 120         branchcode       => 'library_id',
 121         branchname       => 'name',
 122         branchaddress1   => 'address1',
 123         branchaddress2   => 'address2',
 124         branchaddress3   => 'address3',
 125         branchzip        => 'postal_code',
 126         branchcity       => 'city',
 127         branchstate      => 'state',
 128         branchcountry    => 'country',
 129         branchphone      => 'phone',
 130         branchfax        => 'fax',
 131         branchemail      => 'email',
 132         branchreplyto    => 'reply_to_email',
 133         branchreturnpath => 'return_path_email',
 134         branchurl        => 'url',
 135         issuing          => undef,
 136         branchip         => 'ip',
 137         branchnotes      => 'notes',
 138         marcorgcode      => 'marc_org_code',
 139     };
 140 }
 141
 142 =head3 get_hold_libraries
 143
 144 Return all libraries (including self) that belong to the same hold groups
 145
 146 =cut
 147
 148 sub get_hold_libraries {
 149     my ( $self ) = @_;
 150     my $library_groups = $self->library_groups;
 151     my @hold_libraries;
 152     while ( my $library_group = $library_groups->next ) {
 153         my $root = Koha::Library::Groups->get_root_ancestor({id => $library_group->id});
 154         if($root->ft_local_hold_group) {
 155             push @hold_libraries, $root->all_libraries;
 156         }
 157     }
 158
 159     my %seen;
 160     @hold_libraries =
 161       grep { !$seen{ $_->id }++ } @hold_libraries;
 162
 163     return @hold_libraries;
 164 }
 165
 166 =head3 validate_hold_sibling
 167
 168 Return if given library is a valid hold group member
 169
 170 =cut
 171
 172 sub validate_hold_sibling {
 173     my ( $self, $params ) = @_;
 174     my @hold_libraries = $self->get_hold_libraries;
 175
 176     foreach (@hold_libraries) {
 177         my $hold_library = $_;
 178         my $is_valid = 1;
 179         foreach my $key (keys %$params) {
 180             unless($hold_library->$key eq $params->{$key}) {
 181                 $is_valid=0;
 182                 last;
 183             }
 184         }
 185         if($is_valid) {
 186             #Found one library that meets all search parameters
 187             return 1;
 188         }
 189     }
 190     return 0;
 191 }
 192
 193 =head2 Internal methods
 194
 195 =head3 _type
 196
 197 =cut
 198
 199 sub _type {
 200     return 'Branch';
 201 }
 202
 203 1;