Bug 24584: Rewrite optional/sample_news to YAML
[koha.git] / Koha / Suggestion.pm
blob320369161d7734d2a0bf278cf6b1786eecc1b6e6
1 package Koha::Suggestion;
3 # Copyright ByWater Solutions 2015
5 # This file is part of Koha.
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.
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.
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>.
20 use Modern::Perl;
22 use Carp;
24 use Koha::Database;
25 use Koha::DateUtils qw(dt_from_string);
26 use Koha::Patrons;
28 use base qw(Koha::Object);
30 =head1 NAME
32 Koha::Suggestion - Koha Suggestion object class
34 =head1 API
36 =head2 Class methods
38 =cut
40 =head3 store
42 Override the default store behavior so that new suggestions have
43 a suggesteddate of today
45 =cut
47 sub store {
48 my ($self) = @_;
50 unless ( $self->suggesteddate() ) {
51 $self->suggesteddate( dt_from_string()->ymd );
54 return $self->SUPER::store();
57 =head3 suggester
59 my $patron = $suggestion->suggester
61 Returns the I<Koha::Patron> for the suggestion generator. I<undef> is
62 returned if no suggester is linked.
64 =cut
66 sub suggester {
67 my ($self) = @_;
69 my $suggester_rs = $self->_result->suggester;
70 return unless $suggester_rs;
71 return Koha::Patron->_new_from_dbic($suggester_rs);
74 =head2 Internal methods
76 =head3 _type
78 =cut
80 sub _type {
81 return 'Suggestion';
84 =head1 AUTHOR
86 Kyle M Hall <kyle@bywatersolutions.com>
88 =cut