Bug 14610 - Add and update modules
[koha.git] / Koha / ArticleRequest.pm
1 package Koha::ArticleRequest;
2
3 # Copyright ByWater Solutions 2015
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 3 of the License, or (at your option) any later
10 # version.
11 #
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20 use Modern::Perl;
21
22 use Carp;
23
24 use Koha::Database;
25 use Koha::Patrons;
26 use Koha::Biblios;
27 use Koha::Items;
28 use Koha::Libraries;
29 use Koha::ArticleRequest::Status;
30 use Koha::DateUtils qw(dt_from_string);
31
32 use base qw(Koha::Object);
33
34 =head1 NAME
35
36 Koha::ArticleRequest - Koha Article Request Object class
37
38 =head1 API
39
40 =head2 Class Methods
41
42 =cut
43
44 =head3 open
45
46 =cut
47
48 sub open {
49     my ($self) = @_;
50
51     $self->status(Koha::ArticleRequest::Status::Pending);
52     $self->notify();
53     return $self;
54 }
55
56 =head3 process
57
58 =cut
59
60 sub process {
61     my ($self) = @_;
62
63     $self->status(Koha::ArticleRequest::Status::Processing);
64     $self->store();
65     $self->notify();
66     return $self;
67 }
68
69 =head3 complete
70
71 =cut
72
73 sub complete {
74     my ($self) = @_;
75
76     $self->status(Koha::ArticleRequest::Status::Completed);
77     $self->store();
78     $self->notify();
79     return $self;
80 }
81
82 =head3 cancel
83
84 =cut
85
86 sub cancel {
87     my ( $self, $notes ) = @_;
88
89     $self->status(Koha::ArticleRequest::Status::Canceled);
90     $self->notes($notes) if $notes;
91     $self->store();
92     $self->notify();
93     return $self;
94 }
95
96 =head3 notify
97
98 =cut
99
100 sub notify {
101     my ($self) = @_;
102
103     my $status = $self->status;
104
105     if (
106         my $letter = C4::Letters::GetPreparedLetter(
107             module                 => 'circulation',
108             letter_code            => "AR_$status",
109             message_transport_type => 'email',
110             tables                 => {
111                 article_requests => $self->id,
112                 borrowers        => $self->borrowernumber,
113                 biblio           => $self->biblionumber,
114                 biblioitems      => $self->biblionumber,
115                 items            => $self->itemnumber,
116                 branches         => $self->branchcode,
117             },
118         )
119       )
120     {
121         C4::Letters::EnqueueLetter(
122             {
123                 letter                 => $letter,
124                 borrowernumber         => $self->borrowernumber,
125                 message_transport_type => 'email',
126             }
127         ) or warn "can't enqueue letter $letter";
128     }
129 }
130
131 =head3 biblio
132
133 Returns the Koha::Biblio object for this article request
134
135 =cut
136
137 sub biblio {
138     my ($self) = @_;
139
140     $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
141
142     return $self->{_biblio};
143 }
144
145 =head3 item
146
147 Returns the Koha::Item object for this article request
148
149 =cut
150
151 sub item {
152     my ($self) = @_;
153
154     $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
155
156     return $self->{_item};
157 }
158
159 =head3 borrower
160
161 Returns the Koha::Patron object for this article request
162
163 =cut
164
165 sub borrower {
166     my ($self) = @_;
167
168     $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
169
170     return $self->{_borrower};
171 }
172
173 =head3 branch
174
175 Returns the Koha::Library object for this article request
176
177 =cut
178
179 sub branch {
180     my ($self) = @_;
181
182     $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
183
184     return $self->{_branch};
185 }
186
187 =head3 store
188
189 Override the default store behavior so that new opan requests
190 will have notifications sent.
191
192 =cut
193
194 sub store {
195     my ($self) = @_;
196
197     if ( $self->in_storage() ) {
198         my $now = dt_from_string();
199         $self->updated_on($now);
200
201         return $self->SUPER::store();
202     }
203     else {
204         $self->open();
205         return $self->SUPER::store();
206     }
207 }
208
209 =head3 _type
210
211 =cut
212
213 sub _type {
214     return 'ArticleRequest';
215 }
216
217 =head1 AUTHOR
218
219 Kyle M Hall <kyle@bywatersolutions.com>
220
221 =cut
222
223 1;