Bug 32482: (follow-up) Add markup comments
[koha.git] / Koha / Ratings.pm
1 package Koha::Ratings;
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
17
18 use Modern::Perl;
19
20
21 use Koha::Database;
22
23 use Koha::Rating;
24
25 use base qw(Koha::Objects);
26
27 =head1 NAME
28
29 Koha::Ratings - Koha Rating Object set class
30
31 =head1 API
32
33 =head2 Class Methods
34
35 =cut
36
37 =head3 get_avg_rating
38
39 =cut
40
41 sub get_avg_rating {
42     my ( $self ) = @_;
43
44     my $sum   = $self->_resultset->get_column('rating_value')->sum();
45     my $total = $self->count();
46
47     my $avg = 0;
48     if ( $sum and $total ) {
49         eval { $avg = $sum / $total };
50     }
51     $avg = sprintf( "%.1f", $avg );
52
53     return $avg;
54 }
55
56 =head3 type
57
58 =cut
59
60 sub _type {
61     return 'Rating';
62 }
63
64 sub object_class {
65     return 'Koha::Rating';
66 }
67
68 1;