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
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use Modern::Perl;
  21
  22
  23 use Koha::Database;
  24
  25 use Koha::ArticleRequest::Status;
  26 use Koha::ArticleRequest;
  27
  28 use base qw(Koha::Objects);
  29
  30 =head1 NAME
  31
  32 Koha::ArticleRequests - Koha ArticleRequests Object class
  33
  34 =head1 API
  35
  36 =head2 Class methods
  37
  38 =cut
  39
  40 =head3 search_limited
  41
  42 my $article_requests = Koha::ArticleRequests->search_limited( $params, $attributes );
  43
  44 Search for article requests according to logged in patron restrictions
  45
  46 =cut
  47
  48 sub search_limited {
  49     my ( $self, $params, $attributes ) = @_;
  50
  51     my $userenv = C4::Context->userenv;
  52     my @restricted_branchcodes;
  53     if ( $userenv and $userenv->{number} ) {
  54         my $logged_in_user = Koha::Patrons->find( $userenv->{number} );
  55         @restricted_branchcodes = $logged_in_user->libraries_where_can_see_patrons;
  56     }
  57     # TODO This 'borrowernumber' relation name is confusing and needs to be renamed
  58     $params->{'borrowernumber.branchcode'} = { -in => \@restricted_branchcodes } if @restricted_branchcodes;
  59     $attributes->{join} = 'borrowernumber';
  60     return $self->search( $params, $attributes );
  61 }
  62
  63 =head3 filter_by_current
  64
  65     my $current_article_requests = $article_requests->filter_by_current;
  66
  67 Returns a new resultset, filtering out finished article requests.
  68
  69 =cut
  70
  71 sub filter_by_current {
  72     my ($self) = @_;
  73
  74     return $self->search(
  75         {
  76             status => [
  77                 Koha::ArticleRequest::Status::Requested,
  78                 Koha::ArticleRequest::Status::Pending,
  79                 Koha::ArticleRequest::Status::Processing,
  80             ]
  81         }
  82     );
  83 }
  84
  85 =head3 filter_by_finished
  86
  87     my $finished_article_requests = $article_requests->filter_by_finished;
  88
  89 Returns a new resultset, filtering out current article requests.
  90
  91 =cut
  92
  93 sub filter_by_finished {
  94     my ($self) = @_;
  95
  96     return $self->search(
  97         {
  98             status => [
  99                 Koha::ArticleRequest::Status::Completed,
 100                 Koha::ArticleRequest::Status::Canceled,
 101             ]
 102         }
 103     );
 104 }
 105
 106 =head3 requested
 107
 108 =cut
 109
 110 sub requested {
 111     my ( $self, $branchcode ) = @_;
 112     my $params = { status => Koha::ArticleRequest::Status::Requested };
 113     $params->{'me.branchcode'} = $branchcode if $branchcode;
 114     return Koha::ArticleRequests->search_limited($params);
 115 }
 116
 117 =head3 pending
 118
 119 =cut
 120
 121 sub pending {
 122     my ( $self, $branchcode ) = @_;
 123     my $params = { status => Koha::ArticleRequest::Status::Pending };
 124     $params->{'me.branchcode'} = $branchcode if $branchcode;
 125     return Koha::ArticleRequests->search_limited( $params );
 126 }
 127
 128 =head3 processing
 129
 130 =cut
 131
 132 sub processing {
 133     my ( $self, $branchcode ) = @_;
 134     my $params = { status => Koha::ArticleRequest::Status::Processing };
 135     $params->{'me.branchcode'} = $branchcode if $branchcode;
 136     return Koha::ArticleRequests->search_limited( $params );
 137 }
 138
 139 =head3 completed
 140
 141 =cut
 142
 143 sub completed {
 144     my ( $self, $branchcode ) = @_;
 145     my $params = { status => Koha::ArticleRequest::Status::Completed };
 146     $params->{'me.branchcode'} = $branchcode if $branchcode;
 147     return Koha::ArticleRequests->search_limited( $params );
 148 }
 149
 150 =head3 canceled
 151
 152 =cut
 153
 154 sub canceled {
 155     my ( $self, $branchcode ) = @_;
 156     my $params = { status => Koha::ArticleRequest::Status::Canceled };
 157     $params->{'me.branchcode'} = $branchcode if $branchcode;
 158     return Koha::ArticleRequests->search_limited( $params );
 159 }
 160
 161 =head3 _type
 162
 163 =cut
 164
 165 sub _type {
 166     return 'ArticleRequest';
 167 }
 168
 169 sub object_class {
 170     return 'Koha::ArticleRequest';
 171 }
 172
 173 =head1 AUTHOR
 174
 175 Kyle M Hall <kyle@bywatersolutions.com>
 176
 177 =cut
 178
 179 1;