Koha/Subscription.pm

   1 package Koha::Subscription;
   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::Biblios;
  26 use Koha::Acquisition::Booksellers;
  27 use Koha::Subscription::Frequencies;
  28
  29 use base qw(Koha::Object);
  30
  31 =head1 NAME
  32
  33 Koha::Subscription - Koha Subscription Object class
  34
  35 =head1 API
  36
  37 =head2 Class Methods
  38
  39 =cut
  40
  41 =head3 biblio
  42
  43 Returns the biblio linked to this subscription as a Koha::Biblio object
  44
  45 =cut
  46
  47 sub biblio {
  48     my ($self) = @_;
  49
  50     return scalar Koha::Biblios->find($self->biblionumber);
  51 }
  52
  53 =head3 vendor
  54
  55 Returns the vendor/supplier linked to this subscription as a Koha::Acquisition::Bookseller object
  56
  57 =cut
  58
  59 sub vendor {
  60     my ($self) = @_;
  61     return scalar Koha::Acquisition::Booksellers->find($self->aqbooksellerid);
  62 }
  63
  64 =head3 subscribers
  65
  66 my $subscribers = $subscription->subscribers;
  67
  68 return a Koha::Patrons object
  69
  70 =cut
  71
  72 sub subscribers {
  73     my ($self) = @_;
  74     my $schema = Koha::Database->new->schema;
  75     my @borrowernumbers = $schema->resultset('Alert')->search({ externalid => $self->subscriptionid })->get_column( 'borrowernumber' )->all;
  76     return Koha::Patrons->search({ borrowernumber => {-in => \@borrowernumbers } });
  77 }
  78
  79 =head3 add_subscriber
  80
  81 $subscription->add_subscriber( $patron );
  82
  83 Add a new subscriber (Koha::Patron) to this subscription
  84
  85 =cut
  86
  87 sub add_subscriber {
  88     my ( $self, $patron )  = @_;
  89     my $schema = Koha::Database->new->schema;
  90     my $rs = $schema->resultset('Alert');
  91     $rs->create({ externalid => $self->subscriptionid, borrowernumber => $patron->borrowernumber });
  92 }
  93
  94 =head3 remove_subscriber
  95
  96 $subscription->remove_subscriber( $subscriber );
  97
  98 Remove a subscriber (Koha::Patron) from this subscription
  99
 100 =cut
 101
 102 sub remove_subscriber {
 103     my ($self, $patron) = @_;
 104     my $schema = Koha::Database->new->schema;
 105     my $rs = $schema->resultset('Alert');
 106     my $subscriber = $rs->find({ externalid => $self->subscriptionid, borrowernumber => $patron->borrowernumber });
 107     $subscriber->delete if $subscriber;
 108 }
 109
 110 =head3 frequency
 111
 112 my $frequency = $subscription->frequency
 113
 114 Return the subscription frequency
 115
 116 =cut
 117
 118 sub frequency {
 119     my($self)=@_;
 120     my $frequency_rs= $self->_result->periodicity;
 121     return Koha::Subscription::Frequency->_new_from_dbic($frequency_rs);
 122 }
 123
 124 =head3 type
 125
 126 =cut
 127
 128 sub _type {
 129     return 'Subscription';
 130 }
 131
 132 =head1 AUTHOR
 133
 134 Kyle M Hall <kyle@bywatersolutions.com>
 135
 136 =cut
 137
 138 1;