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
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.
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.
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>.
27 use Koha
::StockRotationStages
;
28 use Koha
::SMTP
::Servers
;
30 use base
qw(Koha::Object);
34 Koha::Library - Koha Library Object class
40 =head3 stockrotationstages
42 my $stages = Koha::Library->stockrotationstages;
44 Returns the stockrotation stages associated with this Library.
48 sub stockrotationstages
{
50 my $rs = $self->_result->stockrotationstages;
51 return Koha
::StockRotationStages
->_new_from_dbic( $rs );
54 =head3 get_effective_marcorgcode
56 my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
58 Returns the effective MARC organization code of the library. It falls back to the value
59 from the I<MARCOrgCode> syspref if undefined for the library.
63 sub get_effective_marcorgcode
{
66 return $self->marcorgcode || C4
::Context
->preference("MARCOrgCode");
71 my $smtp_server = $library->smtp_server;
72 $library->smtp_server({ smtp_server => $smtp_server });
73 $library->smtp_server({ smtp_server => undef });
75 Accessor for getting and setting the library's SMTP server.
77 Returns the effective SMTP server configuration to be used on the library. The returned
78 value is always a I<Koha::SMTP::Server> object.
80 Setting it to undef will remove the link to a specific SMTP server and effectively
81 make the library use the default setting
86 my ( $self, $params ) = @_;
88 my $library_smtp_server_rs = $self->_result->library_smtp_server;
90 if ( exists $params->{smtp_server
} ) {
92 $self->_result->result_source->schema->txn_do( sub {
93 $library_smtp_server_rs->delete
94 if $library_smtp_server_rs;
96 if ( defined $params->{smtp_server
} ) {
98 # Remove any already set SMTP server
100 my $smtp_server = $params->{smtp_server
};
101 $smtp_server->_result->add_to_library_smtp_servers({ library_id
=> $self->id });
104 } # else => reset to default
107 if ( $library_smtp_server_rs ) {
108 return Koha
::SMTP
::Servers
->find(
109 $library_smtp_server_rs->smtp_server_id );
112 return Koha
::SMTP
::Servers
->get_default;
118 =head3 inbound_email_address
120 my $to_email = Koha::Library->inbound_email_address;
122 Returns an effective email address which should be accessible to librarians at the branch.
126 sub inbound_email_address
{
131 || $self->branchemail
132 || C4
::Context
->preference('ReplytoDefault')
133 || C4
::Context
->preference('KohaAdminEmailAddress')
137 =head3 inbound_ill_address
139 my $to_email = Koha::Library->inbound_ill_address;
141 Returns an effective email address which should be accessible to librarians at the branch
142 for inter library loans communication.
146 sub inbound_ill_address
{
150 $self->branchillemail
151 || C4
::Context
->preference('ILLDefaultStaffEmail')
152 || $self->inbound_email_address;
155 =head3 library_groups
157 Return the Library groups of this library
163 my $rs = $self->_result->library_groups;
164 return Koha
::Library
::Groups
->_new_from_dbic( $rs );
167 =head3 cash_registers
169 Return Cash::Registers associated with this Library
175 my $rs = $self->_result->cash_registers;
176 return Koha
::Cash
::Registers
->_new_from_dbic( $rs );
179 =head3 to_api_mapping
181 This method returns the mapping for representing a Koha::Library object
188 branchcode
=> 'library_id',
189 branchname
=> 'name',
190 branchaddress1
=> 'address1',
191 branchaddress2
=> 'address2',
192 branchaddress3
=> 'address3',
193 branchzip
=> 'postal_code',
194 branchcity
=> 'city',
195 branchstate
=> 'state',
196 branchcountry
=> 'country',
197 branchphone
=> 'phone',
199 branchemail
=> 'email',
200 branchillemail
=> 'illemail',
201 branchreplyto
=> 'reply_to_email',
202 branchreturnpath
=> 'return_path_email',
206 branchnotes
=> 'notes',
207 marcorgcode
=> 'marc_org_code',
211 =head3 get_hold_libraries
213 Return all libraries (including self) that belong to the same hold groups
217 sub get_hold_libraries
{
219 my $library_groups = $self->library_groups;
221 while ( my $library_group = $library_groups->next ) {
222 my $root = Koha
::Library
::Groups
->get_root_ancestor({id
=> $library_group->id});
223 if($root->ft_local_hold_group) {
224 push @hold_libraries, $root->all_libraries;
230 grep { !$seen{ $_->id }++ } @hold_libraries;
232 return Koha
::Libraries
->search({ branchcode
=> { '-in' => [ keys %seen ] } });
235 =head3 validate_hold_sibling
237 Return if given library is a valid hold group member
241 sub validate_hold_sibling
{
242 my ( $self, $params ) = @_;
243 my @hold_libraries = $self->get_hold_libraries;
245 foreach (@hold_libraries) {
246 my $hold_library = $_;
248 foreach my $key (keys %$params) {
249 unless($hold_library->$key eq $params->{$key}) {
255 #Found one library that meets all search parameters
262 =head2 Internal methods