Koha/Checkout.pm

   1 package Koha::Checkout;
   2
   3 # Copyright ByWater Solutions 2015
   4 # Copyright 2016 Koha Development Team
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use Modern::Perl;
  22
  23 use Carp;
  24 use DateTime;
  25 use Try::Tiny;
  26
  27 use Koha::Checkouts::ReturnClaims;
  28 use Koha::Database;
  29 use Koha::DateUtils;
  30 use Koha::Items;
  31 use Koha::Libraries;
  32
  33 use base qw(Koha::Object);
  34
  35 =head1 NAME
  36
  37 Koha::Checkout - Koha Checkout object class
  38
  39 =head1 API
  40
  41 =head2 Class methods
  42
  43 =cut
  44
  45 =head3 is_overdue
  46
  47 my  $is_overdue = $checkout->is_overdue( [ $reference_dt ] );
  48
  49 Return 1 if the checkout is overdue.
  50
  51 A reference date can be passed, in this case it will be used, otherwise today
  52 will be the reference date.
  53
  54 =cut
  55
  56 sub is_overdue {
  57     my ( $self, $dt ) = @_;
  58     $dt ||= dt_from_string();
  59
  60     my $is_overdue =
  61       DateTime->compare( dt_from_string( $self->date_due, 'sql' ), $dt ) == -1
  62       ? 1
  63       : 0;
  64     return $is_overdue;
  65 }
  66
  67 =head3 item
  68
  69 my $item = $checkout->item;
  70
  71 Return the checked out item
  72
  73 =cut
  74
  75 sub item {
  76     my ( $self ) = @_;
  77     my $item_rs = $self->_result->item;
  78     return Koha::Item->_new_from_dbic( $item_rs );
  79 }
  80
  81 =head3 library
  82
  83 my $library = $checkout->library;
  84
  85 Return the library in which the transaction took place
  86
  87 =cut
  88
  89 sub library {
  90     my ( $self ) = @_;
  91     my $library_rs = $self->_result->library;
  92     return Koha::Library->_new_from_dbic( $library_rs );
  93 }
  94
  95 =head3 patron
  96
  97 my $patron = $checkout->patron
  98
  99 Return the patron for who the checkout has been done
 100
 101 =cut
 102
 103 sub patron {
 104     my ( $self ) = @_;
 105     my $patron_rs = $self->_result->borrower;
 106     return Koha::Patron->_new_from_dbic( $patron_rs );
 107 }
 108
 109 =head3 issued_by
 110
 111 my $issued_by = $checkout->issued_by
 112
 113 Return the patron by whom the checkout was done
 114
 115 =cut
 116
 117 sub issued_by {
 118     my ( $self ) = @_;
 119     my $issued_by_rs = $self->_result->issuer;
 120     return Koha::Patron->_new_from_dbic( $issued_by_rs );
 121 }
 122
 123 =head3 to_api_mapping
 124
 125 This method returns the mapping for representing a Koha::Checkout object
 126 on the API.
 127
 128 =cut
 129
 130 sub to_api_mapping {
 131     return {
 132         issue_id        => 'checkout_id',
 133         borrowernumber  => 'patron_id',
 134         issuer          => 'issuer_id',
 135         itemnumber      => 'item_id',
 136         date_due        => 'due_date',
 137         branchcode      => 'library_id',
 138         returndate      => 'checkin_date',
 139         lastreneweddate => 'last_renewed_date',
 140         issuedate       => 'checkout_date',
 141         notedate        => 'note_date',
 142     };
 143 }
 144
 145 =head3 claim_returned
 146
 147 my $return_claim = $checkout->claim_returned();
 148
 149 =cut
 150
 151 sub claim_returned {
 152     my ( $self, $params ) = @_;
 153
 154     my $charge_lost_fee = $params->{charge_lost_fee};
 155
 156     try {
 157         $self->_result->result_source->schema->txn_do(
 158             sub {
 159                 my $claim = Koha::Checkouts::ReturnClaim->new(
 160                     {
 161                         issue_id       => $self->id,
 162                         itemnumber     => $self->itemnumber,
 163                         borrowernumber => $self->borrowernumber,
 164                         notes          => $params->{notes},
 165                         created_by     => $params->{created_by},
 166                         created_on     => dt_from_string,
 167                     }
 168                 )->store();
 169
 170                 my $ClaimReturnedLostValue = C4::Context->preference('ClaimReturnedLostValue');
 171                 $self->item->itemlost($ClaimReturnedLostValue)->store;
 172
 173                 my $ClaimReturnedChargeFee = C4::Context->preference('ClaimReturnedChargeFee');
 174                 $charge_lost_fee =
 175                     $ClaimReturnedChargeFee eq 'charge'    ? 1
 176                 : $ClaimReturnedChargeFee eq 'no_charge' ? 0
 177                 :   $charge_lost_fee;    # $ClaimReturnedChargeFee eq 'ask'
 178                 C4::Circulation::LostItem( $self->itemnumber, 'claim_returned' ) if $charge_lost_fee;
 179
 180                 return $claim;
 181             }
 182         );
 183     }
 184     catch {
 185         if ( $_->isa('Koha::Exceptions::Exception') ) {
 186             $_->rethrow();
 187         }
 188         else {
 189             # ?
 190             Koha::Exceptions::Exception->throw( "Unhandled exception" );
 191         }
 192     };
 193 }
 194
 195 =head2 Internal methods
 196
 197 =head3 _type
 198
 199 =cut
 200
 201 sub _type {
 202     return 'Issue';
 203 }
 204
 205 =head1 AUTHOR
 206
 207 Kyle M Hall <kyle@bywatersolutions.com>
 208
 209 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
 210
 211 =cut
 212
 213 1;