Bug 32154: DBIC schema
[koha-ffzg.git] / Koha / Checkout.pm
index e256b6c..178a8c0 100644 (file)
@@ -20,14 +20,16 @@ package Koha::Checkout;
 
 use Modern::Perl;
 
-use Carp;
 use DateTime;
-use Try::Tiny;
+use Try::Tiny qw( catch try );
 
+use C4::Circulation qw( LostItem MarkIssueReturned );
+use Koha::Checkouts::Renewals;
 use Koha::Checkouts::ReturnClaims;
 use Koha::Database;
-use Koha::DateUtils;
+use Koha::DateUtils qw( dt_from_string );
 use Koha::Items;
+use Koha::Libraries;
 
 use base qw(Koha::Object);
 
@@ -54,7 +56,8 @@ will be the reference date.
 
 sub is_overdue {
     my ( $self, $dt ) = @_;
-    $dt ||= DateTime->now( time_zone => C4::Context->tz );
+    $dt ||= dt_from_string();
+
     my $is_overdue =
       DateTime->compare( dt_from_string( $self->date_due, 'sql' ), $dt ) == -1
       ? 1
@@ -76,6 +79,34 @@ sub item {
     return Koha::Item->_new_from_dbic( $item_rs );
 }
 
+=head3 account_lines
+
+my $account_lines = $checkout->account_lines;
+
+Return the checked out account_lines
+
+=cut
+
+sub account_lines {
+    my ( $self ) = @_;
+    my $account_lines_rs = $self->_result->account_lines;
+    return Koha::Account::Lines->_new_from_dbic( $account_lines_rs );
+}
+
+=head3 library
+
+my $library = $checkout->library;
+
+Return the library in which the transaction took place
+
+=cut
+
+sub library {
+    my ( $self ) = @_;
+    my $library_rs = $self->_result->library;
+    return Koha::Library->_new_from_dbic( $library_rs );
+}
+
 =head3 patron
 
 my $patron = $checkout->patron
@@ -86,10 +117,40 @@ Return the patron for who the checkout has been done
 
 sub patron {
     my ( $self ) = @_;
-    my $patron_rs = $self->_result->borrower;
+    my $patron_rs = $self->_result->patron;
     return Koha::Patron->_new_from_dbic( $patron_rs );
 }
 
+=head3 issuer
+
+my $issuer = $checkout->issuer
+
+Return the patron by whom the checkout was done
+
+=cut
+
+sub issuer {
+    my ( $self ) = @_;
+    my $issuer_rs = $self->_result->issuer;
+    return unless $issuer_rs;
+    return Koha::Patron->_new_from_dbic( $issuer_rs );
+}
+
+=head3 renewals
+
+  my $renewals = $checkout->renewals;
+
+Return a Koha::Checkouts::Renewals set attached to this checkout
+
+=cut
+
+sub renewals {
+    my ( $self ) = @_;
+    my $renewals_rs = $self->_result->renewals;
+    return unless $renewals_rs;
+    return Koha::Checkouts::Renewals->_new_from_dbic( $renewals_rs );
+}
+
 =head3 to_api_mapping
 
 This method returns the mapping for representing a Koha::Checkout object
@@ -108,12 +169,23 @@ sub to_api_mapping {
         lastreneweddate => 'last_renewed_date',
         issuedate       => 'checkout_date',
         notedate        => 'note_date',
+        noteseen        => 'note_seen',
     };
 }
 
 =head3 claim_returned
 
-my $return_claim = $checkout->claim_returned();
+  my $return_claim = $checkout->claim_returned();
+
+This method sets the checkout as claimed return.  It will:
+
+1.  Add a new row to the `return_claims` table
+2.  Set the item as lost using the 'ClaimReturnedLostValue'
+3.  Charge a fee depending on the value of ClaimReturnedChargeFee
+3a. If set to charge, then accruing overdues will be halted
+3b. If set to charge, then any existing transfers will be cancelled
+    and the holding branch will be set back to 'frombranch'.
+4.  The issue will be marked as returned as per the 'MarkLostItemsAsReturned' preference
 
 =cut
 
@@ -144,19 +216,25 @@ sub claim_returned {
                     $ClaimReturnedChargeFee eq 'charge'    ? 1
                 : $ClaimReturnedChargeFee eq 'no_charge' ? 0
                 :   $charge_lost_fee;    # $ClaimReturnedChargeFee eq 'ask'
-                C4::Circulation::LostItem( $self->itemnumber, 'claim_returned' ) if $charge_lost_fee;
+
+                if ( $charge_lost_fee ) {
+                    C4::Circulation::LostItem( $self->itemnumber, 'claim_returned' );
+                }
+                elsif ( C4::Context->preference( 'MarkLostItemsAsReturned' ) =~ m/claim_returned/ ) {
+                    C4::Circulation::MarkIssueReturned( $self->borrowernumber, $self->itemnumber, undef, $self->patron->privacy );
+                }
 
                 return $claim;
             }
         );
     }
     catch {
-        if ( $_->isa('Koha::Exceptions::Exception') ) {
+        if ( $_->isa('Koha::Exception') ) {
             $_->rethrow();
         }
         else {
             # ?
-            Koha::Exceptions::Exception->throw( "Unhandled exception" );
+            Koha::Exception->throw( "Unhandled exception" );
         }
     };
 }