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
  28 use base qw(Koha::Object);
  29
  30 =head1 NAME
  31
  32 Koha::Club::Enrollment
  33
  34 Represents a "pattern" on which many clubs can be created.
  35 In this way we can directly compare different clubs of the same 'template'
  36 for statistical purposes.
  37
  38 =head1 API
  39
  40 =head2 Class Methods
  41
  42 =cut
  43
  44 =head3 cancel
  45
  46 =cut
  47
  48 sub cancel {
  49     my ( $self ) = @_;
  50
  51     $self->_result()->update( { date_canceled => \'NOW()' } );
  52
  53     return $self;
  54 }
  55
  56 =head3 club
  57
  58 =cut
  59
  60 sub club {
  61     my ( $self ) = @_;
  62     return scalar Koha::Clubs->find( $self->club_id() );
  63 }
  64
  65 =head3 patron
  66
  67 =cut
  68
  69 sub patron {
  70     my ( $self ) = @_;
  71     return scalar Koha::Patrons->find( $self->borrowernumber() );
  72 }
  73
  74 =head3 type
  75
  76 =cut
  77
  78 sub _type {
  79     return 'ClubEnrollment';
  80 }
  81
  82 =head1 AUTHOR
  83
  84 Kyle M Hall <kyle@bywatersolutions.com>
  85
  86 =cut
  87
  88 1;