Koha/Club/Enrollment.pm

   1 package Koha::Club::Enrollment;
   2
   3 # Copyright ByWater Solutions 2014
   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::Clubs;
  26 use Koha::Patrons;
  27 use Koha::DateUtils qw(dt_from_string);
  28 use DateTime;
  29
  30 use base qw(Koha::Object);
  31
  32 =head1 NAME
  33
  34 Koha::Club::Enrollment
  35
  36 Represents a "pattern" on which many clubs can be created.
  37 In this way we can directly compare different clubs of the same 'template'
  38 for statistical purposes.
  39
  40 =head1 API
  41
  42 =head2 Class Methods
  43
  44 =cut
  45
  46 =head3 cancel
  47
  48 =cut
  49
  50 sub cancel {
  51     my ( $self ) = @_;
  52
  53     $self->_result()->update( { date_canceled => \'NOW()' } );
  54
  55     return $self;
  56 }
  57
  58 =head3 club
  59
  60 =cut
  61
  62 sub club {
  63     my ( $self ) = @_;
  64     return scalar Koha::Clubs->find( $self->club_id() );
  65 }
  66
  67 =head3 patron
  68
  69 =cut
  70
  71 sub patron {
  72     my ( $self ) = @_;
  73     return scalar Koha::Patrons->find( $self->borrowernumber() );
  74 }
  75
  76 =head3 is_canceled
  77
  78 Determines if enrollment is canceled
  79
  80 =cut
  81
  82 sub is_canceled {
  83     my ( $self ) = @_;
  84
  85     return 0 unless $self->date_canceled;
  86     my $today = dt_from_string;
  87     my $date_canceled = dt_from_string( $self->date_canceled );
  88
  89     return DateTime->compare($date_canceled, $today) < 1;
  90 }
  91
  92 =head3 type
  93
  94 =cut
  95
  96 sub _type {
  97     return 'ClubEnrollment';
  98 }
  99
 100 =head1 AUTHOR
 101
 102 Kyle M Hall <kyle@bywatersolutions.com>
 103
 104 =cut
 105
 106 1;