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>.
26 use Koha::StockRotationStages;
27 use Koha::SMTP::Servers;
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 outgoing_transfers
55 my $outgoing_transfers = Koha::Library->outgoing_transfers;
57 Returns the outgoing item transfers associated with this Library.
61 sub outgoing_transfers {
63 my $rs = $self->_result->branchtransfers_frombranches;
64 return Koha::Item::Transfers->_new_from_dbic( $rs );
67 =head3 inbound_transfers
69 my $inbound_transfers = Koha::Library->inbound_transfers;
71 Returns the inbound item transfers associated with this Library.
75 sub inbound_transfers {
77 my $rs = $self->_result->branchtransfers_tobranches;
78 return Koha::Item::Transfers->_new_from_dbic( $rs );
81 =head3 get_effective_marcorgcode
83 my $marcorgcode = Koha::Libraries->find( $library_id )->get_effective_marcorgcode();
85 Returns the effective MARC organization code of the library. It falls back to the value
86 from the I<MARCOrgCode> syspref if undefined for the library.
90 sub get_effective_marcorgcode {
93 return $self->marcorgcode || C4::Context->preference("MARCOrgCode");
98 my $smtp_server = $library->smtp_server;
99 $library->smtp_server({ smtp_server => $smtp_server });
100 $library->smtp_server({ smtp_server => undef });
102 Accessor for getting and setting the library's SMTP server.
104 Returns the effective SMTP server configuration to be used on the library. The returned
105 value is always a I<Koha::SMTP::Server> object.
107 Setting it to undef will remove the link to a specific SMTP server and effectively
108 make the library use the default setting
113 my ( $self, $params ) = @_;
115 my $library_smtp_server_rs = $self->_result->library_smtp_server;
117 if ( exists $params->{smtp_server} ) {
119 $self->_result->result_source->schema->txn_do( sub {
120 $library_smtp_server_rs->delete
121 if $library_smtp_server_rs;
123 if ( defined $params->{smtp_server} ) {
125 # Remove any already set SMTP server
127 my $smtp_server = $params->{smtp_server};
128 $smtp_server->_result->add_to_library_smtp_servers({ library_id => $self->id });
131 } # else => reset to default
134 if ( $library_smtp_server_rs ) {
135 return Koha::SMTP::Servers->find(
136 $library_smtp_server_rs->smtp_server_id );
139 return Koha::SMTP::Servers->get_default;
145 =head3 from_email_address
147 my $from_email = Koha::Library->from_email_address;
149 Returns the official 'from' email address for the branch.
151 It may well be a 'noreply' or other inaccessible local domain
152 address that is being used to satisfy spam protection filters.
156 sub from_email_address {
161 || C4::Context->preference('KohaAdminEmailAddress')
165 =head3 inbound_email_address
167 my $to_email = Koha::Library->inbound_email_address;
169 Returns an effective email address which should be accessible to librarians at the branch.
171 NOTE: This is the address to use for 'reply_to' or 'to' fields; It should not usually be
172 used as the 'from' address for emails as it may lead to mail being caught by spam filters.
176 sub inbound_email_address {
181 || $self->branchemail
182 || C4::Context->preference('ReplytoDefault')
183 || C4::Context->preference('KohaAdminEmailAddress')
187 =head3 inbound_ill_address
189 my $to_email = Koha::Library->inbound_ill_address;
191 Returns an effective email address which should be accessible to librarians at the branch
192 for inter library loans communication.
196 sub inbound_ill_address {
200 $self->branchillemail
201 || C4::Context->preference('ILLDefaultStaffEmail')
202 || $self->inbound_email_address;
205 =head3 library_groups
207 Return the Library groups of this library
213 my $rs = $self->_result->library_groups;
214 return Koha::Library::Groups->_new_from_dbic( $rs );
217 =head3 cash_registers
219 Return Cash::Registers associated with this Library
225 my $rs = $self->_result->cash_registers;
226 return Koha::Cash::Registers->_new_from_dbic( $rs );
229 =head3 get_hold_libraries
231 Return all libraries (including self) that belong to the same hold groups
235 sub get_hold_libraries {
237 my $library_groups = $self->library_groups;
239 while ( my $library_group = $library_groups->next ) {
240 my $root = Koha::Library::Groups->get_root_ancestor({id => $library_group->id});
241 if($root->ft_local_hold_group) {
242 push @hold_libraries, $root->all_libraries;
248 grep { !$seen{ $_->id }++ } @hold_libraries;
250 return Koha::Libraries->search({ branchcode => { '-in' => [ keys %seen ] } });
253 =head3 validate_hold_sibling
255 Return if given library is a valid hold group member
259 sub validate_hold_sibling {
260 my ( $self, $params ) = @_;
262 return 1 if $params->{branchcode} eq $self->id;
264 my $branchcode = $params->{branchcode};
265 return $self->get_hold_libraries->search( { branchcode => $branchcode } )
269 =head3 public_read_list
271 This method returns the list of publicly readable database fields for both API and UI output purposes
275 sub public_read_list {
277 'branchcode', 'branchname', 'branchaddress1',
278 'branchaddress2', 'branchaddress3', 'branchzip',
279 'branchcity', 'branchstate', 'branchcountry',
280 'branchfax', 'branchemail', 'branchurl'
284 =head3 to_api_mapping
286 This method returns the mapping for representing a Koha::Library object
293 branchcode => 'library_id',
294 branchname => 'name',
295 branchaddress1 => 'address1',
296 branchaddress2 => 'address2',
297 branchaddress3 => 'address3',
298 branchzip => 'postal_code',
299 branchcity => 'city',
300 branchstate => 'state',
301 branchcountry => 'country',
302 branchphone => 'phone',
304 branchemail => 'email',
305 branchillemail => 'illemail',
306 branchreplyto => 'reply_to_email',
307 branchreturnpath => 'return_path_email',
311 branchnotes => 'notes',
312 marcorgcode => 'marc_org_code',
316 =head2 Internal methods