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;
146 Returns the Koha::Biblio object for this article request
153 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
155 return $self->{_biblio};
160 my $debit = $article_request->debit;
162 Returns the related Koha::Account::Line object for this article request
169 my $debit_rs = $self->_result->debit;
170 return unless $debit_rs;
172 return Koha::Account::Line->_new_from_dbic( $debit_rs );
177 Returns the Koha::Item object for this article request
184 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
186 return $self->{_item};
191 Returns the Koha::Patron object for this article request
198 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
200 return $self->{_borrower};
205 Returns the Koha::Library object for this article request
212 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
214 return $self->{_branch};
219 Override the default store behavior so that new opac requests
220 will have notifications sent.
227 if ( !$self->in_storage ) {
228 $self->created_on( dt_from_string() );
231 return $self->SUPER::store;
234 =head2 Internal methods
240 internal method to be called when changing an article request status.
241 If a letter exists for the new status, it enqueues it.
248 my $status = $self->status;
249 my $reason = $self->notes;
250 if ( !defined $reason && $self->cancellation_reason ) {
251 my $av = Koha::AuthorisedValues->search(
253 category => 'AR_CANCELLATION',
254 authorised_value => $self->cancellation_reason
257 $reason = $av->lib_opac ? $av->lib_opac : $av->lib if $av;
262 my $letter = C4::Letters::GetPreparedLetter(
263 module => 'circulation',
264 letter_code => "AR_$status", # AR_REQUESTED, AR_PENDING, AR_PROCESSING, AR_COMPLETED, AR_CANCELED
265 message_transport_type => 'email',
266 lang => $self->borrower->lang,
268 article_requests => $self->id,
269 borrowers => $self->borrowernumber,
270 biblio => $self->biblionumber,
271 biblioitems => $self->biblionumber,
272 items => $self->itemnumber,
273 branches => $self->branchcode,
281 C4::Letters::EnqueueLetter(
284 borrowernumber => $self->borrowernumber,
285 message_transport_type => 'email',
287 ) or warn "can't enqueue letter " . $letter->{code};
296 return 'ArticleRequest';
301 Kyle M Hall <kyle@bywatersolutions.com>