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 Set the transfer as in transit by updating the datesent time.
85 Also, update date last seen and ensure item holdingbranch is correctly set.
92 # Throw exception if item is still checked out
93 Koha::Exceptions::Item::Transfer::OnLoan->throw() if ( $self->item->checkout );
95 # Remove the 'shelving cart' location status if it is being used (Bug 3701)
96 CartToShelf( $self->item->itemnumber )
97 if $self->item->location
98 && $self->item->location eq 'CART'
99 && (!$self->item->permanent_location
100 || $self->item->permanent_location ne 'CART' );
102 # Update the transit state
105 frombranch => $self->item->holdingbranch,
106 datesent => dt_from_string,
110 ModDateLastSeen( $self->item->itemnumber );
117 Boolean returning whether the transfer is in transit or waiting
124 return ( defined( $self->datesent )
125 && !defined( $self->datearrived )
126 && !defined( $self->datecancelled ) );
131 Receive the transfer by setting the datearrived time.
138 # Throw exception if item is checked out
139 Koha::Exceptions::Item::Transfer::OnLoan->throw() if ($self->item->checkout);
141 # Update the arrived date
142 $self->set({ datearrived => dt_from_string })->store;
144 ModDateLastSeen( $self->item->itemnumber );
150 $transfer->cancel({ reason => $reason, [force => 1]});
152 Cancel the transfer by setting the datecancelled time and recording the reason.
157 my ( $self, $params ) = @_;
159 Koha::Exceptions::MissingParameter->throw(
160 error => "The 'reason' parameter is mandatory" )
161 unless defined($params->{reason});
163 # Throw exception if item is in transit already
164 Koha::Exceptions::Item::Transfer::InTransit->throw() if ( !$params->{force} && $self->in_transit );
166 # Update the cancelled date
168 { datecancelled => dt_from_string, cancellation_reason => $params->{reason} } )
179 return 'Branchtransfer';