Koha/ArticleRequests.pm

   1 package Koha::ArticleRequests;
   2
   3 # Copyright ByWater Solutions 2015
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  15 #
  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.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25
  26 use Koha::ArticleRequest;
  27 use Koha::ArticleRequest::Status;
  28
  29 use base qw(Koha::Objects);
  30
  31 =head1 NAME
  32
  33 Koha::ArticleRequests - Koha ArticleRequests Object class
  34
  35 =head1 API
  36
  37 =head2 Class Methods
  38
  39 =cut
  40
  41 =head3 search_limited
  42
  43 my $article_requests = Koha::ArticleRequests->search_limited( $params, $attributes );
  44
  45 Search for article requests according to logged in patron restrictions
  46
  47 =cut
  48
  49 sub search_limited {
  50     my ( $self, $params, $attributes ) = @_;
  51
  52     my $userenv = C4::Context->userenv;
  53     my @restricted_branchcodes;
  54     if ( $userenv and $userenv->{number} ) {
  55         my $logged_in_user = Koha::Patrons->find( $userenv->{number} );
  56         @restricted_branchcodes = $logged_in_user->libraries_where_can_see_patrons;
  57     }
  58     # TODO This 'borrowernumber' relation name is confusing and needs to be renamed
  59     $params->{'borrowernumber.branchcode'} = { -in => \@restricted_branchcodes } if @restricted_branchcodes;
  60     $attributes->{join} = 'borrowernumber';
  61     return $self->search( $params, $attributes );
  62 }
  63
  64 =head3 pending
  65
  66 =cut
  67
  68 sub pending {
  69     my ( $self, $branchcode ) = @_;
  70     my $params = { status => Koha::ArticleRequest::Status::Pending };
  71     $params->{'me.branchcode'} = $branchcode if $branchcode;
  72     return Koha::ArticleRequests->search_limited( $params );
  73 }
  74
  75 =head3 processing
  76
  77 =cut
  78
  79 sub processing {
  80     my ( $self, $branchcode ) = @_;
  81     my $params = { status => Koha::ArticleRequest::Status::Processing };
  82     $params->{'me.branchcode'} = $branchcode if $branchcode;
  83     return Koha::ArticleRequests->search_limited( $params );
  84 }
  85
  86 =head3 completed
  87
  88 =cut
  89
  90 sub completed {
  91     my ( $self, $branchcode ) = @_;
  92     my $params = { status => Koha::ArticleRequest::Status::Completed };
  93     $params->{'me.branchcode'} = $branchcode if $branchcode;
  94     return Koha::ArticleRequests->search_limited( $params );
  95 }
  96
  97 =head3 canceled
  98
  99 =cut
 100
 101 sub canceled {
 102     my ( $self, $branchcode ) = @_;
 103     my $params = { status => Koha::ArticleRequest::Status::Canceled };
 104     $params->{'me.branchcode'} = $branchcode if $branchcode;
 105     return Koha::ArticleRequests->search_limited( $params );
 106 }
 107
 108 =head3 _type
 109
 110 =cut
 111
 112 sub _type {
 113     return 'ArticleRequest';
 114 }
 115
 116 sub object_class {
 117     return 'Koha::ArticleRequest';
 118 }
 119
 120 =head1 AUTHOR
 121
 122 Kyle M Hall <kyle@bywatersolutions.com>
 123
 124 =cut
 125
 126 1;