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