Koha/Holds.pm

   1 package Koha::Holds;
   2
   3 # Copyright ByWater Solutions 2014
   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::Hold;
  26
  27 use base qw(Koha::Objects);
  28
  29 =head1 NAME
  30
  31 Koha::Holds - Koha Hold object set class
  32
  33 =head1 API
  34
  35 =head2 Class methods
  36
  37 =cut
  38
  39 =head3 waiting
  40
  41 returns a set of holds that are waiting from an existing set
  42
  43 =cut
  44
  45 sub waiting {
  46     my ( $self ) = @_;
  47
  48     return $self->search( { found => 'W' } );
  49 }
  50
  51 =head3 unfilled
  52
  53 returns a set of holds that are unfilled from an existing set
  54
  55 =cut
  56
  57 sub unfilled {
  58     my ( $self ) = @_;
  59
  60     return $self->search( { found => undef } );
  61 }
  62
  63 =head3 forced_hold_level
  64
  65 If a patron has multiple holds for a single record,
  66 those holds must be either all record level holds,
  67 or they must all be item level holds.
  68
  69 This method should be used with Hold sets where all
  70 Hold objects share the same patron and record.
  71
  72 This method will return 'item' if the patron has
  73 at least one item level hold. It will return 'record'
  74 if the patron has holds but none are item level,
  75 Finally, if the patron has no holds, it will return
  76 undef which indicates the patron may select either
  77 record or item level holds, barring any other rules
  78 that would prevent one or the other.
  79
  80 =cut
  81
  82 sub forced_hold_level {
  83     my ($self) = @_;
  84
  85     my $item_level_count = $self->search( { itemnumber => { '!=' => undef } } )->count();
  86     return 'item' if $item_level_count > 0;
  87
  88     my $record_level_count = $self->search( { itemnumber => undef } )->count();
  89     return 'record' if $record_level_count > 0;
  90
  91     return;
  92 }
  93
  94 =head3 get_items_that_can_fill
  95
  96     my $items = $holds->get_items_that_can_fill();
  97
  98 Return the list of items that can fill the hold set.
  99
 100 Items that are not:
 101
 102   in transit
 103   waiting
 104   lost
 105   widthdrawn
 106   not for loan
 107   not on loan
 108
 109 =cut
 110
 111 sub get_items_that_can_fill {
 112     my ( $self ) = @_;
 113
 114     return Koha::Items->new->empty()
 115       unless $self->count() > 0;
 116
 117     my @itemnumbers = $self->search({ 'me.itemnumber' => { '!=' => undef } })->get_column('itemnumber');
 118     my @biblionumbers = $self->search({ 'me.itemnumber' => undef })->get_column('biblionumber');
 119     my @bibs_or_items;
 120     push @bibs_or_items, 'me.itemnumber' => { in => \@itemnumbers } if @itemnumbers;
 121     push @bibs_or_items, 'me.biblionumber' => { in => \@biblionumbers } if @biblionumbers;
 122
 123     my @branchtransfers = Koha::Item::Transfers->search(
 124         {
 125             datearrived => undef,
 126             datecancelled => undef,
 127         },
 128         {
 129             columns  => ['itemnumber'],
 130             collapse => 1,
 131         }
 132     )->get_column('itemnumber');
 133     my @waiting_holds = Koha::Holds->search(
 134         { 'found' => 'W' },
 135         {
 136             columns  => ['itemnumber'],
 137             collapse => 1,
 138         }
 139     )->get_column('itemnumber');
 140
 141     return Koha::Items->search(
 142         {
 143             -or => \@bibs_or_items,
 144             itemnumber   => { -not_in => [ @branchtransfers, @waiting_holds ] },
 145             onloan       => undef,
 146             notforloan   => 0,
 147         }
 148     )->filter_by_for_hold();
 149 }
 150
 151 =head3 filter_by_has_cancellation_requests
 152
 153     my $with_cancellation_reqs = $holds->filter_by_has_cancellation_requests;
 154
 155 Returns a filtered resultset only containing holds that have cancellation requests.
 156
 157 =cut
 158
 159 sub filter_by_has_cancellation_requests {
 160     my ($self) = @_;
 161
 162     return $self->search( { 'hold_cancellation_request_id' => { '!=' => undef } },
 163         { join => 'cancellation_requests' } );
 164 }
 165
 166 =head3 filter_out_has_cancellation_requests
 167
 168     my $holds_without_cancellation_requests = $holds->filter_out_has_cancellation_requests;
 169
 170 Returns a filtered resultset without holds with cancellation requests.
 171
 172 =cut
 173
 174 sub filter_out_has_cancellation_requests {
 175     my ($self) = @_;
 176
 177     return $self->search( { 'hold_cancellation_request_id' => { '=' => undef } },
 178         { join => 'cancellation_requests' } );
 179 }
 180
 181 =head2 Internal methods
 182
 183 =head3 _type
 184
 185 =cut
 186
 187 sub _type {
 188     return 'Reserve';
 189 }
 190
 191 =head3 object_class
 192
 193 =cut
 194
 195 sub object_class {
 196     return 'Koha::Hold';
 197 }
 198
 199 =head1 AUTHOR
 200
 201 Kyle M Hall <kyle@bywatersolutions.com>
 202
 203 =cut
 204
 205 1;