1 package Koha::Checkout;
3 # Copyright ByWater Solutions 2015
4 # Copyright 2016 Koha Development Team
6 # This file is part of Koha.
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.
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.
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>.
27 use Koha::Checkouts::ReturnClaims;
33 use base qw(Koha::Object);
37 Koha::Checkout - Koha Checkout object class
47 my $is_overdue = $checkout->is_overdue( [ $reference_dt ] );
49 Return 1 if the checkout is overdue.
51 A reference date can be passed, in this case it will be used, otherwise today
52 will be the reference date.
57 my ( $self, $dt ) = @_;
58 $dt ||= dt_from_string();
61 DateTime->compare( dt_from_string( $self->date_due, 'sql' ), $dt ) == -1
69 my $item = $checkout->item;
71 Return the checked out item
77 my $item_rs = $self->_result->item;
78 return Koha::Item->_new_from_dbic( $item_rs );
83 my $library = $checkout->library;
85 Return the library in which the transaction took place
91 my $library_rs = $self->_result->library;
92 return Koha::Library->_new_from_dbic( $library_rs );
97 my $patron = $checkout->patron
99 Return the patron for who the checkout has been done
105 my $patron_rs = $self->_result->borrower;
106 return Koha::Patron->_new_from_dbic( $patron_rs );
111 my $issuer = $checkout->issuer
113 Return the patron by whom the checkout was done
119 my $issuer_rs = $self->_result->issuer;
120 return unless $issuer_rs;
121 return Koha::Patron->_new_from_dbic( $issuer_rs );
124 =head3 to_api_mapping
126 This method returns the mapping for representing a Koha::Checkout object
133 issue_id => 'checkout_id',
134 borrowernumber => 'patron_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',
145 =head3 claim_returned
147 my $return_claim = $checkout->claim_returned();
152 my ( $self, $params ) = @_;
154 my $charge_lost_fee = $params->{charge_lost_fee};
157 $self->_result->result_source->schema->txn_do(
159 my $claim = Koha::Checkouts::ReturnClaim->new(
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,
170 my $ClaimReturnedLostValue = C4::Context->preference('ClaimReturnedLostValue');
171 $self->item->itemlost($ClaimReturnedLostValue)->store;
173 my $ClaimReturnedChargeFee = C4::Context->preference('ClaimReturnedChargeFee');
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;
185 if ( $_->isa('Koha::Exceptions::Exception') ) {
190 Koha::Exceptions::Exception->throw( "Unhandled exception" );
195 =head2 Internal methods
207 Kyle M Hall <kyle@bywatersolutions.com>
209 Jonathan Druart <jonathan.druart@bugs.koha-community.org>