Koha/Suggestion.pm

   1 package Koha::Suggestion;
   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
   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 use Carp;
  23
  24 use Koha::Database;
  25 use Koha::DateUtils qw(dt_from_string);
  26 use Koha::Patrons;
  27
  28 use base qw(Koha::Object);
  29
  30 =head1 NAME
  31
  32 Koha::Suggestion - Koha Suggestion object class
  33
  34 =head1 API
  35
  36 =head2 Class methods
  37
  38 =cut
  39
  40 =head3 store
  41
  42 Override the default store behavior so that new suggestions have
  43 a suggesteddate of today
  44
  45 =cut
  46
  47 sub store {
  48     my ($self) = @_;
  49
  50     unless ( $self->suggesteddate() ) {
  51         $self->suggesteddate( dt_from_string()->ymd );
  52     }
  53
  54     return $self->SUPER::store();
  55 }
  56
  57 =head3 suggester
  58
  59     my $patron = $suggestion->suggester
  60
  61 Returns the I<Koha::Patron> for the suggestion generator. I<undef> is
  62 returned if no suggester is linked.
  63
  64 =cut
  65
  66 sub suggester {
  67     my ($self) = @_;
  68
  69     my $suggester_rs = $self->_result->suggester;
  70     return unless $suggester_rs;
  71     return Koha::Patron->_new_from_dbic($suggester_rs);
  72 }
  73
  74 =head3 manager
  75
  76 my $manager = $suggestion->manager;
  77
  78 Returns the manager of the suggestion (Koha::Patron for managedby field)
  79
  80 =cut
  81
  82 sub manager {
  83     my ($self) = @_;
  84     my $manager_rs = $self->_result->managedby;
  85     return unless $manager_rs;
  86     return Koha::Patron->_new_from_dbic($manager_rs);
  87 }
  88
  89 =head3 rejecter
  90
  91 my $rejecter = $suggestion->rejecter;
  92
  93 Returns the rejecter of the suggestion (Koha::Patron for rejectebby field)
  94
  95 =cut
  96
  97 sub rejecter {
  98     my ($self) = @_;
  99     my $rejecter_rs = $self->_result->managedby;
 100     return unless $rejecter_rs;
 101     return Koha::Patron->_new_from_dbic($rejecter_rs);
 102 }
 103
 104 =head3 last_modifier
 105
 106 my $last_modifier = $suggestion->last_modifier;
 107
 108 Returns the librarian who last modified the suggestion (Koha::Patron for lastmodificationby field)
 109
 110 =cut
 111
 112 sub last_modifier {
 113     my ($self) = @_;
 114     my $last_modifier_rs = $self->_result->managedby;
 115     return unless $last_modifier_rs;
 116     return Koha::Patron->_new_from_dbic($last_modifier_rs);
 117 }
 118
 119 =head3 fund
 120
 121 my $fund = $suggestion->fund;
 122
 123 Return the fund associated to the suggestion
 124
 125 =cut
 126
 127 sub fund {
 128     my ($self) = @_;
 129     my $fund_rs = $self->_result->budgetid;
 130     return unless $fund_rs;
 131     return Koha::Acquisition::Fund->_new_from_dbic($fund_rs);
 132 }
 133
 134 =head3 type
 135
 136 =cut
 137
 138 sub _type {
 139     return 'Suggestion';
 140 }
 141
 142 =head1 AUTHOR
 143
 144 Kyle M Hall <kyle@bywatersolutions.com>
 145
 146 =cut
 147
 148 1;