koha-dev.rot13.org Git - srvgit/blob - 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 pending
  64
  65 =cut
  66
  67 sub pending {
  68     my ( $self, $branchcode ) = @_;
  69     my $params = { status => Koha::ArticleRequest::Status::Pending };
  70     $params->{'me.branchcode'} = $branchcode if $branchcode;
  71     return Koha::ArticleRequests->search_limited( $params );
  72 }
  73
  74 =head3 processing
  75
  76 =cut
  77
  78 sub processing {
  79     my ( $self, $branchcode ) = @_;
  80     my $params = { status => Koha::ArticleRequest::Status::Processing };
  81     $params->{'me.branchcode'} = $branchcode if $branchcode;
  82     return Koha::ArticleRequests->search_limited( $params );
  83 }
  84
  85 =head3 completed
  86
  87 =cut
  88
  89 sub completed {
  90     my ( $self, $branchcode ) = @_;
  91     my $params = { status => Koha::ArticleRequest::Status::Completed };
  92     $params->{'me.branchcode'} = $branchcode if $branchcode;
  93     return Koha::ArticleRequests->search_limited( $params );
  94 }
  95
  96 =head3 canceled
  97
  98 =cut
  99
 100 sub canceled {
 101     my ( $self, $branchcode ) = @_;
 102     my $params = { status => Koha::ArticleRequest::Status::Canceled };
 103     $params->{'me.branchcode'} = $branchcode if $branchcode;
 104     return Koha::ArticleRequests->search_limited( $params );
 105 }
 106
 107 =head3 _type
 108
 109 =cut
 110
 111 sub _type {
 112     return 'ArticleRequest';
 113 }
 114
 115 sub object_class {
 116     return 'Koha::ArticleRequest';
 117 }
 118
 119 =head1 AUTHOR
 120
 121 Kyle M Hall <kyle@bywatersolutions.com>
 122
 123 =cut
 124
 125 1;