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