Koha/Account/Lines.pm

   1 package Koha::Account::Lines;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19
  20 use Carp;
  21 use List::Util qw( sum0 );
  22
  23 use Koha::Database;
  24 use Koha::Account::Line;
  25
  26 use base qw(Koha::Objects);
  27
  28 =head1 NAME
  29
  30 Koha::Cities - Koha City Object set class
  31 Koha::Account::Lines - Koha Account Line Object set class
  32
  33 =head1 API
  34
  35 =head2 Class Methods
  36
  37 =head3 total_outstanding
  38
  39     my $lines = Koha::Account::Lines->search({ ...  });
  40     my $total = $lines->total_outstanding;
  41
  42 Returns the sum of the outstanding amounts of the resultset. If the resultset is
  43 empty it returns 0.
  44
  45 =cut
  46
  47 sub total_outstanding {
  48     my ( $self ) = @_;
  49
  50     my $total = sum0( $self->get_column('amountoutstanding') );
  51
  52     return $total;
  53 }
  54
  55 =head2 Internal methods
  56
  57 =head3 _type
  58
  59 =cut
  60
  61 sub _type {
  62     return 'Accountline';
  63 }
  64
  65 sub object_class {
  66     return 'Koha::Account::Line';
  67 }
  68
  69 1;