koha-dev.rot13.org Git - srvgit/blob - Koha/Account/Offset.pm

   1 package Koha::Account::Offset;
   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 use Koha::Account::Lines;
  23
  24 use base qw(Koha::Object);
  25
  26 =head1 NAME
  27
  28 Koha::Account::Offset - Koha account offset Object class
  29
  30 Account offsets are used to track the changes in account lines
  31
  32 =head1 API
  33
  34 =head2 Internal methods
  35
  36 =cut
  37
  38 =head3 debit
  39
  40 my $debit = $account_offset->debit;
  41
  42 Returns the related accountline that increased the amount owed by the patron.
  43
  44 =cut
  45
  46 sub debit {
  47     my ( $self ) = @_;
  48     my $debit_rs = $self->_result->debit;
  49     return unless $debit_rs;
  50     return Koha::Account::Line->_new_from_dbic( $debit_rs );
  51 }
  52
  53 =head3 credit
  54
  55 my $credit = $account_offset->credit;
  56
  57 Returns the related accountline that decreased the amount owed by the patron.
  58
  59 =cut
  60
  61 sub credit {
  62     my ( $self ) = @_;
  63     my $credit_rs = $self->_result->credit;
  64     return unless $credit_rs;
  65     return Koha::Account::Line->_new_from_dbic( $credit_rs );
  66 }
  67
  68 =head3 _type
  69
  70 =cut
  71
  72 sub _type {
  73     return 'AccountOffset';
  74 }
  75
  76 1;