Koha/Reviews.pm

   1 package Koha::Reviews;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19
  20 use Carp;
  21
  22 use Koha::Database;
  23
  24 use Koha::Review;
  25
  26 use base qw(Koha::Objects);
  27
  28 =head1 NAME
  29
  30 Koha::Reviews - Koha Review Object set class
  31
  32 =head1 API
  33
  34 =head2 Class Methods
  35
  36 =cut
  37
  38 =head2 search_limited
  39
  40 my $reviews = Koha::Reviews->search_limited( $params, $attributes );
  41
  42 Search for reviews according to logged in patron restrictions
  43
  44 =cut
  45
  46 sub search_limited {
  47     my ( $self, $params, $attributes ) = @_;
  48
  49     my $userenv = C4::Context->userenv;
  50     my @restricted_branchcodes;
  51     if ( $userenv and $userenv->{number} ) {
  52         my $logged_in_user = Koha::Patrons->find( $userenv->{number} );
  53         @restricted_branchcodes = $logged_in_user->libraries_where_can_see_patrons;
  54     }
  55     # TODO This 'borrowernumber' relation name is confusing and needs to be renamed
  56     $params->{'borrowernumber.branchcode'} = { -in => \@restricted_branchcodes } if @restricted_branchcodes;
  57     $attributes->{join} = 'borrowernumber';
  58     return $self->search( $params, $attributes );
  59 }
  60
  61 =head3 type
  62
  63 =cut
  64
  65 sub _type {
  66     return 'Review';
  67 }
  68
  69 sub object_class {
  70     return 'Koha::Review';
  71 }
  72
  73 1;