Koha/Club.pm

   1 package Koha::Club;
   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
  26 use Koha::Club::Templates;
  27 use Koha::Club::Fields;
  28 use Koha::Libraries;
  29
  30 use base qw(Koha::Object);
  31
  32 =head1 NAME
  33
  34 Koha::Club - Koha Club Object class
  35
  36 =head1 API
  37
  38 =head2 Class Methods
  39
  40 =cut
  41
  42 =head3 club_template
  43
  44 =cut
  45
  46 sub club_template {
  47     my ($self) = @_;
  48
  49     return unless $self->club_template_id();
  50
  51     return Koha::Club::Templates->find( $self->club_template_id() );
  52 }
  53
  54 =head3 club_fields
  55
  56 =cut
  57
  58 sub club_fields {
  59     my ($self) = @_;
  60
  61     return unless $self->id();
  62
  63     return Koha::Club::Fields->search( { club_id => $self->id() } );
  64 }
  65
  66 =head3 club_enrollments
  67
  68 =cut
  69
  70 sub club_enrollments {
  71     my ($self) = @_;
  72
  73     return unless $self->id();
  74
  75     return scalar Koha::Club::Enrollments->search( { club_id => $self->id(), date_canceled => undef } );
  76 }
  77
  78 =head3 club_fields
  79
  80 =cut
  81
  82 sub branch {
  83     my ($self) = @_;
  84
  85     return unless $self->branchcode();
  86
  87     return Koha::Libraries->find( $self->branchcode() );
  88 }
  89
  90 =head3 type
  91
  92 =cut
  93
  94 sub _type {
  95     return 'Club';
  96 }
  97
  98 =head1 AUTHOR
  99
 100 Kyle M Hall <kyle@bywatersolutions.com>
 101
 102 =cut
 103
 104 1;