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
   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.
  11 #
  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.
  16 #
  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>.
  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::DateUtils qw(dt_from_string);
  30
  31 use base qw(Koha::Object);
  32
  33 =head1 NAME
  34
  35 Koha::ArticleRequest - Koha Article Request Object class
  36
  37 =head1 API
  38
  39 =head2 Class Methods
  40
  41 =cut
  42
  43 =head3 open
  44
  45 =cut
  46
  47 sub open {
  48     my ($self) = @_;
  49
  50     $self->status(Koha::ArticleRequest::Status::Pending);
  51     $self->SUPER::store();
  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     require C4::Letters;
 106     if (
 107         my $letter = C4::Letters::GetPreparedLetter(
 108             module                 => 'circulation',
 109             letter_code            => "AR_$status", # AR_PENDING, AR_PROCESSING, AR_COMPLETED, AR_CANCELED
 110             message_transport_type => 'email',
 111             lang                   => $self->borrower->lang,
 112             tables                 => {
 113                 article_requests => $self->id,
 114                 borrowers        => $self->borrowernumber,
 115                 biblio           => $self->biblionumber,
 116                 biblioitems      => $self->biblionumber,
 117                 items            => $self->itemnumber,
 118                 branches         => $self->branchcode,
 119             },
 120         )
 121       )
 122     {
 123         C4::Letters::EnqueueLetter(
 124             {
 125                 letter                 => $letter,
 126                 borrowernumber         => $self->borrowernumber,
 127                 message_transport_type => 'email',
 128             }
 129         ) or warn "can't enqueue letter $letter";
 130     }
 131 }
 132
 133 =head3 biblio
 134
 135 Returns the Koha::Biblio object for this article request
 136
 137 =cut
 138
 139 sub biblio {
 140     my ($self) = @_;
 141
 142     $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
 143
 144     return $self->{_biblio};
 145 }
 146
 147 =head3 item
 148
 149 Returns the Koha::Item object for this article request
 150
 151 =cut
 152
 153 sub item {
 154     my ($self) = @_;
 155
 156     $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
 157
 158     return $self->{_item};
 159 }
 160
 161 =head3 borrower
 162
 163 Returns the Koha::Patron object for this article request
 164
 165 =cut
 166
 167 sub borrower {
 168     my ($self) = @_;
 169
 170     $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
 171
 172     return $self->{_borrower};
 173 }
 174
 175 =head3 branch
 176
 177 Returns the Koha::Library object for this article request
 178
 179 =cut
 180
 181 sub branch {
 182     my ($self) = @_;
 183
 184     $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
 185
 186     return $self->{_branch};
 187 }
 188
 189 =head3 store
 190
 191 Override the default store behavior so that new opac requests
 192 will have notifications sent.
 193
 194 =cut
 195
 196 sub store {
 197     my ($self) = @_;
 198     if ( $self->in_storage ) {
 199         return $self->SUPER::store;
 200     } else {
 201         $self->created_on( dt_from_string() );
 202         return $self->open;
 203     }
 204 }
 205
 206 =head3 _type
 207
 208 =cut
 209
 210 sub _type {
 211     return 'ArticleRequest';
 212 }
 213
 214 =head1 AUTHOR
 215
 216 Kyle M Hall <kyle@bywatersolutions.com>
 217
 218 =cut
 219
 220 1;