Bug 20402: Add missing POD
[koha.git] / Koha / Libraries.pm
blob38a61a4325faa00ded7d42617b5ec41f976ade6b
1 package Koha::Libraries;
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
10 # version.
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.
20 use Modern::Perl;
22 use Carp;
24 use C4::Context;
26 use Koha::Database;
27 use Koha::Library;
29 use base qw(Koha::Objects);
31 =head1 NAME
33 Koha::Libraries - Koha Library Object set class
35 =head1 API
37 =head2 Class Methods
39 =cut
41 =head3 search_filtered
43 =cut
45 sub search_filtered {
46 my ( $self, $params, $attributes ) = @_;
48 my @branchcodes;
49 my $userenv = C4::Context->userenv;
50 if ( $userenv and $userenv->{number} ) {
51 my $only_from_group = $params->{only_from_group};
52 if ( $only_from_group ) {
53 my $logged_in_user = Koha::Patrons->find( $userenv->{number} );
54 my @branchcodes = $logged_in_user->libraries_where_can_see_patrons;
55 $params->{branchcode} = { -in => \@branchcodes } if @branchcodes;
56 } else {
57 if ( C4::Context::only_my_library ) {
58 $params->{branchcode} = C4::Context->userenv->{branch};
62 delete $params->{only_from_group};
63 return $self->SUPER::search( $params, $attributes );
66 =head3 type
68 =cut
70 sub _type {
71 return 'Branch';
74 sub object_class {
75 return 'Koha::Library';