1 package Koha::ArticleRequest;
3 # Copyright ByWater Solutions 2015
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use Koha::Account::Lines;
28 use Koha::DateUtils qw( dt_from_string );
29 use Koha::ArticleRequest::Status;
30 use Koha::Exceptions::ArticleRequest;
32 use base qw(Koha::Object);
36 Koha::ArticleRequest - Koha Article Request Object class
46 $article_request->request;
48 Marks the article as requested. Send a notification if appropriate.
55 Koha::Exceptions::ArticleRequest::LimitReached->throw(
56 error => 'Patron cannot request more articles for today'
57 ) unless $self->borrower->can_request_article;
59 $self->status(Koha::ArticleRequest::Status::Requested);
61 # Handle possible fees
62 my $debit = $self->borrower->add_article_request_fee_if_needed({ item_id => $self->itemnumber });
63 $self->debit_id( $debit->id )
73 $article_request->set_pending;
75 Marks the article as pending. Send a notification if appropriate.
82 $self->status(Koha::ArticleRequest::Status::Pending);
90 $article_request->process;
92 Marks the article as in process. Send a notification if appropriate.
99 $self->status(Koha::ArticleRequest::Status::Processing);
107 $article_request->complete;
109 Marks the article as completed. Send a notification if appropriate.
116 $self->status(Koha::ArticleRequest::Status::Completed);
124 $article_request->cancel;
126 Marks the article as cancelled. Send a notification if appropriate.
131 my ( $self, $params ) = @_;
133 my $cancellation_reason = $params->{cancellation_reason};
134 my $notes = $params->{notes};
136 $self->status(Koha::ArticleRequest::Status::Canceled);
137 $self->cancellation_reason($cancellation_reason) if $cancellation_reason;
138 $self->notes($notes) if $notes;
142 my $debit = $self->debit;
146 my $account = $self->borrower->account;
148 my $total_reversible = $debit->debit_offsets->filter_by_reversible->total;
149 if ( $total_reversible ) {
151 $account->add_credit(
153 amount => abs $total_reversible,
154 interface => C4::Context->interface,
160 if ( $debit->amountoutstanding ) {
162 reduction_type => 'REFUND',
163 amount => $debit->amountoutstanding,
164 interface => C4::Context->interface,
174 Returns the Koha::Biblio object for this article request
181 my $rs = $self->_result->biblionumber;
183 return Koha::Biblio->_new_from_dbic($rs);
188 my $debit = $article_request->debit;
190 Returns the related Koha::Account::Line object for this article request
197 my $debit_rs = $self->_result->debit;
198 return unless $debit_rs;
200 return Koha::Account::Line->_new_from_dbic( $debit_rs );
205 Returns the Koha::Item object for this article request
211 my $rs = $self->_result->itemnumber;
213 return Koha::Item->_new_from_dbic($rs);
218 Returns the Koha::Patron object for this article request
224 my $rs = $self->_result->borrowernumber;
226 return Koha::Patron->_new_from_dbic($rs);
231 Returns the Koha::Library object for this article request
237 my $rs = $self->_result->branchcode;
239 return Koha::Library->_new_from_dbic($rs);
244 Override the default store behavior so that new opac requests
245 will have notifications sent.
252 if ( !$self->in_storage ) {
253 $self->created_on( dt_from_string() );
256 return $self->SUPER::store;
259 =head2 Internal methods
265 internal method to be called when changing an article request status.
266 If a letter exists for the new status, it enqueues it.
273 my $status = $self->status;
274 my $reason = $self->notes;
275 if ( !defined $reason && $self->cancellation_reason ) {
276 my $av = Koha::AuthorisedValues->search(
278 category => 'AR_CANCELLATION',
279 authorised_value => $self->cancellation_reason
282 $reason = $av->lib_opac ? $av->lib_opac : $av->lib if $av;
287 my $letter = C4::Letters::GetPreparedLetter(
288 module => 'circulation',
289 letter_code => "AR_$status", # AR_REQUESTED, AR_PENDING, AR_PROCESSING, AR_COMPLETED, AR_CANCELED
290 message_transport_type => 'email',
291 lang => $self->borrower->lang,
293 article_requests => $self->id,
294 borrowers => $self->borrowernumber,
295 biblio => $self->biblionumber,
296 biblioitems => $self->biblionumber,
297 items => $self->itemnumber,
298 branches => $self->branchcode,
306 C4::Letters::EnqueueLetter(
309 borrowernumber => $self->borrowernumber,
310 message_transport_type => 'email',
312 ) or warn "can't enqueue letter " . $letter->{code};
321 return 'ArticleRequest';
326 Kyle M Hall <kyle@bywatersolutions.com>