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 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::Hold;
  27
  28 use base qw(Koha::Objects);
  29
  30 =head1 NAME
  31
  32 Koha::Holds - Koha Hold object set class
  33
  34 =head1 API
  35
  36 =head2 Class Methods
  37
  38 =cut
  39
  40 =head3 waiting
  41
  42 Returns a set of holds that are waiting from an existing set
  43
  44 =cut
  45
  46 sub waiting {
  47     my ( $self ) = @_;
  48
  49     return $self->search( { found => 'W' } );
  50 }
  51
  52 =head3 forced_hold_level
  53
  54 If a patron has multiple holds for a single record,
  55 those holds must be either all record level holds,
  56 or they must all be item level holds.
  57
  58 This method should be used with Hold sets where all
  59 Hold objects share the same patron and record.
  60
  61 This method will return 'item' if the patron has
  62 at least one item level hold. It will return 'record'
  63 if the patron has holds but none are item level,
  64 Finally, if the patron has no holds, it will return
  65 undef which indicates the patron may select either
  66 record or item level holds, barring any other rules
  67 that would prevent one or the other.
  68
  69 =cut
  70
  71 sub forced_hold_level {
  72     my ($self) = @_;
  73
  74     my $item_level_count = $self->search( { itemnumber => { '!=' => undef } } )->count();
  75     return 'item' if $item_level_count > 0;
  76
  77     my $record_level_count = $self->search( { itemnumber => undef } )->count();
  78     return 'record' if $record_level_count > 0;
  79
  80     return;
  81 }
  82
  83 =head3 type
  84
  85 =cut
  86
  87 sub _type {
  88     return 'Reserve';
  89 }
  90
  91 =head3 object_class
  92
  93 =cut
  94
  95 sub object_class {
  96     return 'Koha::Hold';
  97 }
  98
  99 =head1 AUTHOR
 100
 101 Kyle M Hall <kyle@bywatersolutions.com>
 102
 103 =cut
 104
 105 1;