Attachment 76440 Details for Bug 20978 – Bug 20978: Add Koha::Account::add_credit

[patch] Bug 20978: Add Koha::Account::add_credit

Bug-20978-Add-KohaAccountaddcredit.patch (text/plain), 5.32 KB, created by Kyle M Hall (khall) on 2018-06-26 13:59:59 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Kyle M Hall (khall)

Created: 2018-06-26 13:59:59 UTC

Size: 5.32 KB

patch

obsolete

>From 24b124d92662251b89c3a73b44239cb17aacad40 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Thu, 21 Jun 2018 13:04:01 -0300
>Subject: [PATCH] Bug 20978: Add Koha::Account::add_credit
>
>This patch adds:
>- Koha::Account::add_credit
>- A single source of truth for accounttype and offset_type values
>
>To test:
>- Apply the first patch
>- Run:
>  $ kshell
> k$ prove t/db_dependent/Koha/Account.t
>=> FAIL: Tests fail!
>- Apply this patch
>- Run:
> k$ prove t/db_dependent/Koha/Account.t
>=> SUCCESS: Tests pass!
>- Sign off :-D
>
>Signed-off-by: Josef Moravec <josef.moravec@gmail.com>
>
>Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
>---
> Koha/Account.pm | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 134 insertions(+)
>
>diff --git a/Koha/Account.pm b/Koha/Account.pm
>index bffc98bd65..e5141ff7f7 100644
>--- a/Koha/Account.pm
>+++ b/Koha/Account.pm
>@@ -264,6 +264,116 @@ sub pay {
>     return $payment->id;
> }
> 
>+=head3 add_credit
>+
>+This method allows adding credits to a patron's account
>+
>+my $credit_line = Koha::Account->new({ patron_id => $patron_id })->add_credit(
>+    {
>+        amount       => $amount,
>+        description  => $description,
>+        note         => $note,
>+        user_id      => $user_id,
>+        library_id   => $library_id,
>+        sip          => $sip,
>+        payment_type => $payment_type,
>+        type         => $credit_type,
>+        item_id      => $item_id
>+    }
>+);
>+
>+$credit_type can be any of 'credit', 'payment', 'forgiven' or 'writeoff'
>+
>+=cut
>+
>+sub add_credit {
>+
>+    my ( $self, $params ) = @_;
>+
>+    # amount is passed as a positive value, but we store credit as negative values
>+    my $amount       = $params->{amount} * -1;
>+    my $description  = $params->{description} // q{};
>+    my $note         = $params->{note} // q{};
>+    my $user_id      = $params->{user_id};
>+    my $library_id   = $params->{library_id};
>+    my $sip          = $params->{sip};
>+    my $payment_type = $params->{payment_type};
>+    my $type         = $params->{type} || 'payment';
>+    my $item_id      = $params->{item_id};
>+
>+    my $schema = Koha::Database->new->schema;
>+
>+    my $account_type = $Koha::Account::account_type->{$type};
>+    $account_type .= $sip
>+        if defined $sip &&
>+           $type eq 'payment';
>+
>+    my $line;
>+
>+    $schema->txn_do(
>+        sub {
>+            # We should remove accountno, it is no longer needed
>+            my $last = Koha::Account::Lines->search( { borrowernumber => $self->{patron_id} },
>+                { order_by => 'accountno' } )->next();
>+            my $accountno = $last ? $last->accountno + 1 : 1;
>+
>+            # Insert the account line
>+            $line = Koha::Account::Line->new(
>+                {   borrowernumber    => $self->{patron_id},
>+                    date              => \'NOW()',
>+                    amount            => $amount,
>+                    description       => $description,
>+                    accounttype       => $account_type,
>+                    amountoutstanding => $amount,
>+                    payment_type      => $payment_type,
>+                    note              => $note,
>+                    manager_id        => $user_id,
>+                    itemnumber        => $item_id
>+                }
>+            )->store();
>+
>+            # Record the account offset
>+            my $account_offset = Koha::Account::Offset->new(
>+                {   credit_id => $line->id,
>+                    type      => $Koha::Account::offset_type->{$type},
>+                    amount    => $amount
>+                }
>+            )->store();
>+
>+            UpdateStats(
>+                {   branch         => $library_id,
>+                    type           => $type,
>+                    amount         => $amount,
>+                    borrowernumber => $self->{patron_id},
>+                    accountno      => $accountno,
>+                }
>+            );
>+
>+            if ( C4::Context->preference("FinesLog") ) {
>+                logaction(
>+                    "FINES", 'CREATE',
>+                    $self->{patron_id},
>+                    Dumper(
>+                        {   action            => "create_$type",
>+                            borrowernumber    => $self->{patron_id},
>+                            accountno         => $accountno,
>+                            amount            => $amount,
>+                            description       => $description,
>+                            amountoutstanding => $amount,
>+                            accounttype       => $account_type,
>+                            note              => $note,
>+                            itemnumber        => $item_id,
>+                            manager_id        => $user_id,
>+                        }
>+                    )
>+                );
>+            }
>+        }
>+    );
>+
>+    return $line;
>+}
>+
> =head3 balance
> 
> my $balance = $self->balance
>@@ -363,6 +473,30 @@ sub non_issues_charges {
> 
> 1;
> 
>+=head2 Name mappings
>+
>+=head3 $offset_type
>+
>+=cut
>+
>+our $offset_type = {
>+    'credit'   => 'Payment',
>+    'forgiven' => 'Writeoff',
>+    'payment'  => 'Payment',
>+    'writeoff' => 'Writeoff'
>+};
>+
>+=head3 $account_type
>+
>+=cut
>+
>+our $account_type = {
>+    'credit'   => 'C',
>+    'forgiven' => 'FOR',
>+    'payment'  => 'Pay',
>+    'writeoff' => 'W'
>+};
>+
> =head1 AUTHOR
> 
> Kyle M Hall <kyle.m.hall@gmail.com>
>-- 
>2.15.2 (Apple Git-101.1)

Actions: View | Diff | Splinter Review

Attachments on bug 20978: 76240 | 76241 | 76242 | 76243 | 76244 | 76245 | 76278 | 76279 | 76280 | 76319 | 76320 | 76321 | 76396 | 76397 | 76398 | 76439 | 76440 | 76441 | 76515 | 76633 | 76634 | 76635 | 76636 | 76726 | 76727 | 76733