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 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::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 =head2 Internal methods
  75
  76 =head3 _type
  77
  78 =cut
  79
  80 sub _type {
  81     return 'Suggestion';
  82 }
  83
  84 =head1 AUTHOR
  85
  86 Kyle M Hall <kyle@bywatersolutions.com>
  87
  88 =cut
  89
  90 1;