3 # Copyright 2015 Koha Development team
5 # This file is part of Koha.
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
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.
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.
27 use Koha::StockRotationStages;
29 use base qw(Koha::Object);
33 Koha::Library - Koha Library Object class
39 =head3 stockrotationstages
41 my $stages = Koha::Library->stockrotationstages;
43 Returns the stockrotation stages associated with this Library.
47 sub stockrotationstages {
49 my $rs = $self->_result->stockrotationstages;
50 return Koha::StockRotationStages->_new_from_dbic( $rs );
53 =head3 get_effective_marcorgcode
55 my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
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.
62 sub get_effective_marcorgcode {
65 return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
70 Return the Library groups of this library
76 my $rs = $self->_result->library_groups;
77 return Koha::Library::Groups->_new_from_dbic( $rs );
82 Return Cash::Registers associated with this Library
88 my $rs = $self->_result->cash_registers;
89 return Koha::Cash::Registers->_new_from_dbic( $rs );
94 This method returns the mapping for representing a Koha::Library object
101 branchcode => 'library_id',
102 branchname => 'name',
103 branchaddress1 => 'address1',
104 branchaddress2 => 'address2',
105 branchaddress3 => 'address3',
106 branchzip => 'postal_code',
107 branchcity => 'city',
108 branchstate => 'state',
109 branchcountry => 'country',
110 branchphone => 'phone',
112 branchemail => 'email',
113 branchreplyto => 'reply_to_email',
114 branchreturnpath => 'return_path_email',
118 branchprinter => undef,
119 branchnotes => 'notes',
120 marcorgcode => 'marc_org_code',
124 =head3 get_hold_libraries
126 Return all libraries (including self) that belong to the same hold groups
130 sub get_hold_libraries {
132 my $library_groups = $self->library_groups;
134 while ( my $library_group = $library_groups->next ) {
135 my $root = Koha::Library::Groups->get_root_ancestor({id => $library_group->id});
136 if($root->ft_local_hold_group) {
137 push @hold_libraries, $root->all_libraries;
143 grep { !$seen{ $_->id }++ } @hold_libraries;
145 return @hold_libraries;
148 =head3 validate_hold_sibling
150 Return if given library is a valid hold group member
154 sub validate_hold_sibling {
155 my ( $self, $params ) = @_;
156 my @hold_libraries = $self->get_hold_libraries;
158 foreach (@hold_libraries) {
159 my $hold_library = $_;
161 foreach my $key (keys %$params) {
162 unless($hold_library->$key eq $params->{$key}) {
168 #Found one library that meets all search parameters
175 =head2 Internal methods