1 package Koha::Item::Transfer;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use C4::Items qw( CartToShelf ModDateLastSeen );
24 use Koha::DateUtils qw( dt_from_string );
25 use Koha::Exceptions::Item::Transfer;
27 use base qw(Koha::Object);
31 Koha::Item::Transfer - Koha Item Transfer Object class
41 my $item = $transfer->item;
43 Returns the associated item for this transfer.
49 my $item_rs = $self->_result->itemnumber;
50 return Koha::Item->_new_from_dbic($item_rs);
55 my $from_library = $transfer->from_library;
57 Returns the associated from_library for this transfer.
63 my $from_library_rs = $self->_result->frombranch;
64 return Koha::Library->_new_from_dbic($from_library_rs);
69 my $to_library = $transfer->to_library;
71 Returns the associated to_library for this transfer.
77 my $to_library_rs = $self->_result->tobranch;
78 return Koha::Library->_new_from_dbic($to_library_rs);
83 $transfer->transit({ [ skip_record_index => 0|1 ] });
85 Set the transfer as in transit by updating the I<datesent> time.
87 Also, update date last seen and ensure item holdingbranch is correctly set.
89 An optional I<skip_record_index> parameter can be passed to avoid triggering
95 my ($self, $params) = @_;
97 # Throw exception if item is still checked out
98 Koha::Exceptions::Item::Transfer::OnLoan->throw() if ( $self->item->checkout );
100 # Remove the 'shelving cart' location status if it is being used (Bug 3701)
101 CartToShelf( $self->item->itemnumber )
102 if $self->item->location
103 && $self->item->location eq 'CART'
104 && (!$self->item->permanent_location
105 || $self->item->permanent_location ne 'CART' );
107 # Update the transit state
110 frombranch => $self->item->holdingbranch,
111 datesent => dt_from_string,
115 ModDateLastSeen( $self->item->itemnumber, undef, { skip_record_index => $params->{skip_record_index} } );
122 Boolean returning whether the transfer is in transit or waiting
129 return ( defined( $self->datesent )
130 && !defined( $self->datearrived )
131 && !defined( $self->datecancelled ) );
136 Receive the transfer by setting the datearrived time.
143 # Throw exception if item is checked out
144 Koha::Exceptions::Item::Transfer::OnLoan->throw() if ($self->item->checkout);
146 # Update the arrived date
147 $self->set({ datearrived => dt_from_string })->store;
149 ModDateLastSeen( $self->item->itemnumber );
155 $transfer->cancel({ reason => $reason, [force => 1]});
157 Cancel the transfer by setting the datecancelled time and recording the reason.
162 my ( $self, $params ) = @_;
164 Koha::Exceptions::MissingParameter->throw(
165 error => "The 'reason' parameter is mandatory" )
166 unless defined($params->{reason});
168 # Throw exception if item is in transit already
169 Koha::Exceptions::Item::Transfer::InTransit->throw() if ( !$params->{force} && $self->in_transit );
171 # Update the cancelled date
173 { datecancelled => dt_from_string, cancellation_reason => $params->{reason} } )
184 return 'Branchtransfer';