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
42 Library specific store to ensure relevant caches are flushed on change
51 if ( !$self->in_storage ) {
55 my $self_from_storage = $self->get_from_storage;
56 $flush = 1 if ( $self_from_storage->branchname ne $self->branchname );
59 $self = $self->SUPER::store;
62 my $cache = Koha::Caches->get_instance();
63 $cache->clear_from_cache('libraries:name');
69 =head3 stockrotationstages
71 my $stages = Koha::Library->stockrotationstages;
73 Returns the stockrotation stages associated with this Library.
77 sub stockrotationstages {
79 my $rs = $self->_result->stockrotationstages;
80 return Koha::StockRotationStages->_new_from_dbic( $rs );
83 =head3 outgoing_transfers
85 my $outgoing_transfers = Koha::Library->outgoing_transfers;
87 Returns the outgoing item transfers associated with this Library.
91 sub outgoing_transfers {
93 my $rs = $self->_result->branchtransfers_frombranches;
94 return Koha::Item::Transfers->_new_from_dbic( $rs );
97 =head3 inbound_transfers
99 my $inbound_transfers = Koha::Library->inbound_transfers;
101 Returns the inbound item transfers associated with this Library.
105 sub inbound_transfers {
107 my $rs = $self->_result->branchtransfers_tobranches;
108 return Koha::Item::Transfers->_new_from_dbic( $rs );
111 =head3 get_effective_marcorgcode
113 my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
115 Returns the effective MARC organization code of the library. It falls back to the value
116 from the I<MARCOrgCode> syspref if undefined for the library.
120 sub get_effective_marcorgcode {
123 return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
128 my $smtp_server = $library->smtp_server;
129 $library->smtp_server({ smtp_server => $smtp_server });
130 $library->smtp_server({ smtp_server => undef });
132 Accessor for getting and setting the library's SMTP server.
134 Returns the effective SMTP server configuration to be used on the library. The returned
135 value is always a I<Koha::SMTP::Server> object.
137 Setting it to undef will remove the link to a specific SMTP server and effectively
138 make the library use the default setting
143 my ( $self, $params ) = @_;
145 my $library_smtp_server_rs = $self->_result->library_smtp_server;
147 if ( exists $params->{smtp_server} ) {
149 $self->_result->result_source->schema->txn_do( sub {
150 $library_smtp_server_rs->delete
151 if $library_smtp_server_rs;
153 if ( defined $params->{smtp_server} ) {
155 # Remove any already set SMTP server
157 my $smtp_server = $params->{smtp_server};
158 $smtp_server->_result->add_to_library_smtp_servers({ library_id => $self->id });
161 } # else => reset to default
164 if ( $library_smtp_server_rs ) {
165 return Koha::SMTP::Servers->find(
166 $library_smtp_server_rs->smtp_server_id );
169 return Koha::SMTP::Servers->get_default;
175 =head3 from_email_address
177 my $from_email = Koha::Library->from_email_address;
179 Returns the official 'from' email address for the branch.
181 It may well be a 'noreply' or other inaccessible local domain
182 address that is being used to satisfy spam protection filters.
186 sub from_email_address {
191 || C4::Context->preference('KohaAdminEmailAddress')
195 =head3 inbound_email_address
197 my $to_email = Koha::Library->inbound_email_address;
199 Returns an effective email address which should be accessible to librarians at the branch.
201 NOTE: This is the address to use for 'reply_to' or 'to' fields; It should not usually be
202 used as the 'from' address for emails as it may lead to mail being caught by spam filters.
206 sub inbound_email_address {
211 || $self->branchemail
212 || C4::Context->preference('ReplytoDefault')
213 || C4::Context->preference('KohaAdminEmailAddress')
217 =head3 inbound_ill_address
219 my $to_email = Koha::Library->inbound_ill_address;
221 Returns an effective email address which should be accessible to librarians at the branch
222 for inter library loans communication.
226 sub inbound_ill_address {
230 $self->branchillemail
231 || C4::Context->preference('ILLDefaultStaffEmail')
232 || $self->inbound_email_address;
235 =head3 library_groups
237 Return the Library groups of this library
243 my $rs = $self->_result->library_groups;
244 return Koha::Library::Groups->_new_from_dbic( $rs );
247 =head3 cash_registers
249 Return Cash::Registers associated with this Library
255 my $rs = $self->_result->cash_registers;
256 return Koha::Cash::Registers->_new_from_dbic( $rs );
259 =head3 get_hold_libraries
261 Return all libraries (including self) that belong to the same hold groups
265 sub get_hold_libraries {
267 my $library_groups = $self->library_groups;
269 while ( my $library_group = $library_groups->next ) {
270 my $root = Koha::Library::Groups->get_root_ancestor({id => $library_group->id});
271 if($root->ft_local_hold_group) {
272 push @hold_libraries, $root->all_libraries;
278 grep { !$seen{ $_->id }++ } @hold_libraries;
280 return Koha::Libraries->search({ branchcode => { '-in' => [ keys %seen ] } });
283 =head3 validate_hold_sibling
285 Return if given library is a valid hold group member
289 sub validate_hold_sibling {
290 my ( $self, $params ) = @_;
292 return 1 if $params->{branchcode} eq $self->id;
294 my $branchcode = $params->{branchcode};
295 return $self->get_hold_libraries->search( { branchcode => $branchcode } )
299 =head3 public_read_list
301 This method returns the list of publicly readable database fields for both API and UI output purposes
305 sub public_read_list {
307 'branchcode', 'branchname', 'branchaddress1',
308 'branchaddress2', 'branchaddress3', 'branchzip',
309 'branchcity', 'branchstate', 'branchcountry',
310 'branchfax', 'branchemail', 'branchurl'
314 =head3 to_api_mapping
316 This method returns the mapping for representing a Koha::Library object
323 branchcode => 'library_id',
324 branchname => 'name',
325 branchaddress1 => 'address1',
326 branchaddress2 => 'address2',
327 branchaddress3 => 'address3',
328 branchzip => 'postal_code',
329 branchcity => 'city',
330 branchstate => 'state',
331 branchcountry => 'country',
332 branchphone => 'phone',
334 branchemail => 'email',
335 branchillemail => 'illemail',
336 branchreplyto => 'reply_to_email',
337 branchreturnpath => 'return_path_email',
341 branchnotes => 'notes',
342 marcorgcode => 'marc_org_code',
348 $library->opac_info({ lang => $lang });
350 Returns additional contents block OpacLibraryInfo for $lang or 'default'.
352 Note: This replaces the former branches.opac_info column.
357 my ( $self, $params ) = @_;
358 return Koha::AdditionalContents->find_best_match({
359 category => 'html_customizations',
360 location => 'OpacLibraryInfo',
361 lang => $params->{lang},
362 library_id => $self->branchcode,
366 =head2 Internal methods