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