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
   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 use Carp;
  21
  22 use Koha::Database;
  23 use Koha::Account::Line;
  24
  25 use base qw(Koha::Objects);
  26
  27 =head1 NAME
  28
  29 Koha::Account::Lines - Koha Account Line Object set class
  30
  31 =head1 API
  32
  33 =head2 Class Methods
  34
  35 =head3 total_outstanding
  36
  37     my $lines = Koha::Account::Lines->search({ ...  });
  38     my $total = $lines->total_outstanding;
  39
  40 Returns the sum of the outstanding amounts of the resultset. If the resultset is
  41 empty it returns 0.
  42
  43 =cut
  44
  45 sub total_outstanding {
  46     my ($self) = @_;
  47
  48     my $me = $self->_resultset()->current_source_alias . ".";
  49     my $lines = $self->search(
  50         {},
  51         {
  52             select => [ { sum => $me.'amountoutstanding' } ],
  53             as     => ['total_amountoutstanding'],
  54         }
  55     );
  56
  57     return $lines->count
  58       ? $lines->next->get_column('total_amountoutstanding') + 0
  59       : 0;
  60 }
  61
  62 =head3 total
  63
  64     my $lines = Koha::Account::Lines->search({ ...  });
  65     my $total = $lines->total;
  66
  67 Returns the sum of the amounts of the resultset. If the resultset is
  68 empty it returns 0.
  69
  70 =cut
  71
  72 sub total {
  73     my ( $self, $conditions ) = @_;
  74
  75     $conditions //= {};
  76     my $me = $self->_resultset()->current_source_alias . ".";
  77     my $lines = $self->search(
  78         $conditions,
  79         {
  80             select => [ { sum => $me.'amount' } ],
  81             as     => ['total']
  82         }
  83     );
  84     return $lines->count ? $lines->next->get_column('total') + 0 : 0;
  85 }
  86
  87 =head3 credits_total
  88
  89     my $lines = Koha::Account::Lines->search({ ...  });
  90     my $credits_total = $lines->credits_total;
  91
  92 Returns the sum of the amounts of the resultset. If the resultset is
  93 empty it returns 0.
  94
  95 =cut
  96
  97 sub credits_total {
  98     my ( $self, $conditions ) = @_;
  99
 100     my $me = $self->_resultset()->current_source_alias . ".";
 101     my $local_conditions = { $me.'amount' => { '<' => 0 } };
 102     $conditions //= {};
 103     my $merged_conditions = { %{$conditions}, %{$local_conditions} };
 104
 105     my $lines = $self->search(
 106         $merged_conditions,
 107         {
 108             select => [ { sum => $me.'amount' } ],
 109             as     => ['total']
 110         }
 111     );
 112     return $lines->count ? $lines->next->get_column('total') + 0 : 0;
 113 }
 114
 115 =head3 debits_total
 116
 117     my $lines = Koha::Account::Lines->search({ ...  });
 118     my $debits_total = $lines->debits_total;
 119
 120 Returns the sum of the amounts of the resultset. If the resultset is
 121 empty it returns 0.
 122
 123 =cut
 124
 125 sub debits_total {
 126     my ( $self, $conditions ) = @_;
 127
 128     my $me = $self->_resultset()->current_source_alias . ".";
 129     my $local_conditions = { $me.'amount' => { '>' => 0 } };
 130     $conditions //= {};
 131     my $merged_conditions = { %{$conditions}, %{$local_conditions} };
 132
 133     my $lines = $self->search(
 134         $merged_conditions,
 135         {
 136             select => [ { sum => $me.'amount' } ],
 137             as     => ['total']
 138         }
 139     );
 140     return $lines->count ? $lines->next->get_column('total') + 0 : 0;
 141 }
 142
 143 =head2 Internal methods
 144
 145 =head3 _type
 146
 147 =cut
 148
 149 sub _type {
 150     return 'Accountline';
 151 }
 152
 153 sub object_class {
 154     return 'Koha::Account::Line';
 155 }
 156
 157 1;