Bug 26922: Regression tests
[koha.git] / Koha / Suggestion.pm
blobf9f8c2a49087cd681eb2c9ed30ad61ed6fb34d73
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 =head3 manager
76 my $manager = $suggestion->manager;
78 Returns the manager of the suggestion (Koha::Patron for managedby field)
80 =cut
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);
89 =head3 rejecter
91 my $rejecter = $suggestion->rejecter;
93 Returns the rejecter of the suggestion (Koha::Patron for rejectebby field)
95 =cut
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);
104 =head3 last_modifier
106 my $last_modifier = $suggestion->last_modifier;
108 Returns the librarian who last modified the suggestion (Koha::Patron for lastmodificationby field)
110 =cut
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);
119 =head3 fund
121 my $fund = $suggestion->fund;
123 Return the fund associated to the suggestion
125 =cut
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);
134 =head3 type
136 =cut
138 sub _type {
139 return 'Suggestion';
142 =head1 AUTHOR
144 Kyle M Hall <kyle@bywatersolutions.com>
146 =cut