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
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22
  23 use Koha::Database;
  24
  25 use Koha::Club::Templates;
  26 use Koha::Club::Fields;
  27 use Koha::Libraries;
  28
  29 use base qw(Koha::Object);
  30
  31 =head1 NAME
  32
  33 Koha::Club - Koha Club Object class
  34
  35 =head1 API
  36
  37 =head2 Class Methods
  38
  39 =cut
  40
  41 =head3 club_template
  42
  43 =cut
  44
  45 sub club_template {
  46     my ($self) = @_;
  47
  48     return unless $self->club_template_id();
  49
  50     return Koha::Club::Templates->find( $self->club_template_id() );
  51 }
  52
  53 =head3 club_fields
  54
  55 =cut
  56
  57 sub club_fields {
  58     my ($self) = @_;
  59
  60     return unless $self->id();
  61
  62     return Koha::Club::Fields->search( { club_id => $self->id() } );
  63 }
  64
  65 =head3 club_enrollments
  66
  67 =cut
  68
  69 sub club_enrollments {
  70     my ($self) = @_;
  71
  72     return unless $self->id();
  73
  74     return Koha::Club::Enrollments->search( { club_id => $self->id(), date_canceled => undef } );
  75 }
  76
  77 =head3 club_fields
  78
  79 =cut
  80
  81 sub branch {
  82     my ($self) = @_;
  83
  84     return unless $self->branchcode();
  85
  86     return Koha::Libraries->find( $self->branchcode() );
  87 }
  88
  89 =head3 type
  90
  91 =cut
  92
  93 sub _type {
  94     return 'Club';
  95 }
  96
  97 =head1 AUTHOR
  98
  99 Kyle M Hall <kyle@bywatersolutions.com>
 100
 101 =cut
 102
 103 1;