[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Koha-cvs] CVS: koha/C4 Accounts2.pm,1.12,1.13
From: |
Andrew Arensburger |
Subject: |
[Koha-cvs] CVS: koha/C4 Accounts2.pm,1.12,1.13 |
Date: |
Fri, 27 Sep 2002 21:56:28 -0700 |
Update of /cvsroot/koha/koha/C4
In directory usw-pr-cvs1:/tmp/cvs-serv19089
Modified Files:
Accounts2.pm
Log Message:
Added POD.
Removed extraneous trailing whitespace.
Index: Accounts2.pm
===================================================================
RCS file: /cvsroot/koha/koha/C4/Accounts2.pm,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** Accounts2.pm 14 Aug 2002 18:12:51 -0000 1.12
--- Accounts2.pm 28 Sep 2002 04:56:26 -0000 1.13
***************
*** 27,42 ****
use C4::Circulation::Circ2;
use vars qw($VERSION @ISA @EXPORT);
!
# set the version for version checking
! $VERSION = 0.01;
!
@ISA = qw(Exporter);
@EXPORT = qw(&recordpayment &fixaccounts &makepayment &manualinvoice
&getnextacctno);
sub displayaccounts{
my ($env)address@hidden;
}
sub recordpayment{
#here we update both the accountoffsets and the account lines
--- 27,81 ----
use C4::Circulation::Circ2;
use vars qw($VERSION @ISA @EXPORT);
!
# set the version for version checking
! $VERSION = 0.01; # FIXME - Should probably be different from
! # the version for C4::Accounts
!
! =head1 NAME
!
! C4::Accounts - Functions for dealing with Koha accounts
!
! =head1 SYNOPSIS
!
! use C4::Accounts;
!
! =head1 DESCRIPTION
!
! The functions in this module deal with the monetary aspect of Koha,
! including looking up and modifying the amount of money owed by a
! patron.
!
! =head1 FUNCTIONS
!
! =over 2
!
! =cut
!
@ISA = qw(Exporter);
@EXPORT = qw(&recordpayment &fixaccounts &makepayment &manualinvoice
&getnextacctno);
+ # FIXME - Never used
sub displayaccounts{
my ($env)address@hidden;
}
+ =item recordpayment
+
+ &recordpayment($env, $borrowernumber, $payment);
+
+ Record payment by a patron. C<$borrowernumber> is the patron's
+ borrower number. C<$payment> is a floating-point number, giving the
+ amount that was paid. C<$env> is a reference-to-hash;
+ C<$env-E<gt>{branchcode}> is the code of the branch where payment was
+ made.
+
+ Amounts owed are paid off oldest first. That is, if the patron has a
+ $1 fine from Feb. 1, another $1 fine from Mar. 1, and makes a payment
+ of $1.50, then the oldest fine will be paid off in full, and $0.50
+ will be credited to the next one.
+
+ =cut
+ #'
sub recordpayment{
#here we update both the accountoffsets and the account lines
***************
*** 51,55 ****
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
! my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding<>0)
order by date";
--- 90,94 ----
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
! my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding<>0)
order by date";
***************
*** 71,75 ****
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
--- 110,114 ----
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
***************
*** 79,84 ****
}
# create new line
! $updquery = "insert into accountlines
! (borrowernumber,
accountno,date,amount,description,accounttype,amountoutstanding)
values ($bornumber,$nextaccntno,now(),0-$data,'Payment,thanks',
'Pay',0-$amountleft)";
--- 118,123 ----
}
# create new line
! $updquery = "insert into accountlines
! (borrowernumber,
accountno,date,amount,description,accounttype,amountoutstanding)
values ($bornumber,$nextaccntno,now(),0-$data,'Payment,thanks',
'Pay',0-$amountleft)";
***************
*** 91,97 ****
}
sub makepayment{
#here we update both the accountoffsets and the account lines
! #updated to check, if they are paying off a lost item, we return the item
# from their card, and put a note on the item record
my ($bornumber,$accountno,$amount,$user)address@hidden;
--- 130,153 ----
}
+ =item makepayment
+
+ &makepayment($borrowernumber, $acctnumber, $amount, $branchcode);
+
+ Records the fact that a patron has paid off the entire amount he or
+ she owes.
+
+ C<$borrowernumber> is the patron's borrower number. C<$acctnumber> is
+ the account that was credited. C<$amount> is the amount paid (this is
+ only used to record the payment. It is assumed to be equal to the
+ amount owed). C<$branchcode> is the code of the branch where payment
+ was made.
+
+ =cut
+ #'
+ # FIXME - I'm not at all sure about the above, because I don't
+ # understand what the acct* tables in the Koha database are for.
sub makepayment{
#here we update both the accountoffsets and the account lines
! #updated to check, if they are paying off a lost item, we return the item
# from their card, and put a note on the item record
my ($bornumber,$accountno,$amount,$user)address@hidden;
***************
*** 107,110 ****
--- 163,168 ----
my $data=$sth->fetchrow_hashref;
$sth->finish;
+ # FIXME - This prepare/execute/finish sequence could be done with
+ # $dbh->do(), no?
my $updquery="Update accountlines set amountoutstanding=0 where
borrowernumber=$bornumber and accountno=$accountno";
***************
*** 113,130 ****
$sth->finish;
# print $updquery;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accountno,$nextaccntno,$newamtos)";
my $usth = $dbh->prepare($updquery);
$usth->execute;
! $usth->finish;
# create new line
my $payment=0-$amount;
! $updquery = "insert into accountlines
! (borrowernumber,
accountno,date,amount,description,accounttype,amountoutstanding)
values ($bornumber,$nextaccntno,now(),$payment,'Payment,thanks - $user',
'Pay',0)";
$usth = $dbh->prepare($updquery);
$usth->execute;
$usth->finish;
UpdateStats($env,$user,'payment',$amount,'','','',$bornumber);
$sth->finish;
--- 171,190 ----
$sth->finish;
# print $updquery;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accountno,$nextaccntno,$newamtos)";
my $usth = $dbh->prepare($updquery);
$usth->execute;
! $usth->finish;
# create new line
my $payment=0-$amount;
! $updquery = "insert into accountlines
! (borrowernumber,
accountno,date,amount,description,accounttype,amountoutstanding)
values ($bornumber,$nextaccntno,now(),$payment,'Payment,thanks - $user',
'Pay',0)";
$usth = $dbh->prepare($updquery);
$usth->execute;
$usth->finish;
+ # FIXME - The second argument to &UpdateStats is supposed to be the
+ # branch code.
UpdateStats($env,$user,'payment',$amount,'','','',$bornumber);
$sth->finish;
***************
*** 136,139 ****
--- 196,213 ----
}
+ =item getnextacctno
+
+ $nextacct = &getnextacctno($env, $borrowernumber, $dbh);
+
+ Returns the next unused account number for the patron with the given
+ borrower number.
+
+ C<$dbh> is a DBI::db handle to the Koha database.
+
+ C<$env> is ignored.
+
+ =cut
+ #'
+ # FIXME - Okay, so what does the above actually _mean_?
sub getnextacctno {
my ($env,$bornumber,$dbh)address@hidden;
***************
*** 151,154 ****
--- 225,235 ----
}
+ =item fixaccounts
+
+ &fixaccounts($borrowernumber, $accountnumber, $amount);
+
+ =cut
+ #'
+ # FIXME - I don't understand what this function does.
sub fixaccounts {
my ($borrowernumber,$accountno,$amount)address@hidden;
***************
*** 159,162 ****
--- 240,244 ----
$sth->execute;
my $data=$sth->fetchrow_hashref;
+ # FIXME - Error-checking
my $diff=$amount-$data->{'amount'};
my $outstanding=$data->{'amountoutstanding'}+$diff;
***************
*** 171,174 ****
--- 253,257 ----
}
+ # FIXME - Never used, but not exported, either.
sub returnlost{
my ($borrnum,$itemnum)address@hidden;
***************
*** 190,193 ****
--- 273,291 ----
}
+ =item manualinvoice
+
+ &manualinvoice($borrowernumber, $itemnumber, $description, $type,
+ $amount, $user);
+
+ C<$borrowernumber> is the patron's borrower number.
+ C<$description> is a description of the transaction.
+ C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
+ or C<REF>.
+ C<$itemnumber> is the item involved, if pertinent; otherwise, it
+ should be the empty string.
+
+ =cut
+ #'
+ # FIXME - Okay, so what does this function do, really?
sub manualinvoice{
my ($bornum,$itemnum,$desc,$type,$amount,$user)address@hidden;
***************
*** 198,205 ****
my $accountno=getnextacctno('',$bornum,$dbh);
my $amountleft=$amount;
!
if ($type eq 'CS' || $type eq 'CB' || $type eq 'CW'
|| $type eq 'CF' || $type eq 'CL'){
! my $amount2=$amount*-1;
$amountleft=fixcredit(\%env,$bornum,$amount2,$itemnum,$type,$user);
}
--- 296,303 ----
my $accountno=getnextacctno('',$bornum,$dbh);
my $amountleft=$amount;
!
if ($type eq 'CS' || $type eq 'CB' || $type eq 'CW'
|| $type eq 'CF' || $type eq 'CL'){
! my $amount2=$amount*-1; # FIXME - $amount2 = -$amount
$amountleft=fixcredit(\%env,$bornum,$amount2,$itemnum,$type,$user);
}
***************
*** 211,215 ****
}
if ($type eq 'REF'){
! $amountleft=refund('',$bornum,$amount);
}
if ($itemnum ne ''){
--- 309,313 ----
}
if ($type eq 'REF'){
! $amountleft=refund('',$bornum,$amount);
}
if ($itemnum ne ''){
***************
*** 227,238 ****
values ($bornum,$accountno,now(),'$amount',$desc,'$type','$amountleft')";
}
!
my $sth=$dbh->prepare($insert);
$sth->execute;
$sth->finish;
!
$dbh->disconnect;
}
!
sub fixcredit{
#here we update both the accountoffsets and the account lines
--- 325,341 ----
values ($bornum,$accountno,now(),'$amount',$desc,'$type','$amountleft')";
}
!
my $sth=$dbh->prepare($insert);
$sth->execute;
$sth->finish;
!
$dbh->disconnect;
}
!
! # fixcredit
! # $amountleft = &fixcredit($env, $bornumber, $data, $barcode, $type, $user);
! #
! # This function is only used internally.
! # FIXME - Figure out what this function does, and write it down.
sub fixcredit{
#here we update both the accountoffsets and the account lines
***************
*** 243,247 ****
my $accdata = "";
my $amountleft = $data;
! if ($barcode ne ''){
my $item=getiteminformation($env,'',$barcode);
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
--- 346,350 ----
my $accdata = "";
my $amountleft = $data;
! if ($barcode ne ''){
my $item=getiteminformation($env,'',$barcode);
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
***************
*** 260,264 ****
$sth->execute;
$accdata=$sth->fetchrow_hashref;
! $sth->finish;
if ($accdata->{'amountoutstanding'} < $amountleft) {
$newamtos = 0;
--- 363,367 ----
$sth->execute;
$accdata=$sth->fetchrow_hashref;
! $sth->finish;
if ($accdata->{'amountoutstanding'} < $amountleft) {
$newamtos = 0;
***************
*** 274,278 ****
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
--- 377,381 ----
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
***************
*** 284,288 ****
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
! my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding >0)
order by date";
--- 387,391 ----
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
! my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding >0)
order by date";
***************
*** 305,309 ****
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
--- 408,412 ----
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
***************
*** 319,325 ****
$amountleft*=-1;
return($amountleft);
!
}
sub refund{
#here we update both the accountoffsets and the account lines
--- 422,429 ----
$amountleft*=-1;
return($amountleft);
!
}
+ # FIXME - Figure out what this function does, and write it down.
sub refund{
#here we update both the accountoffsets and the account lines
***************
*** 331,339 ****
# my $branch=$env->{'branchcode'};
my $amountleft = $data *-1;
!
# begin transaction
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
! my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding<0)
order by date";
--- 435,443 ----
# my $branch=$env->{'branchcode'};
my $amountleft = $data *-1;
!
# begin transaction
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
! my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding<0)
order by date";
***************
*** 358,362 ****
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
--- 462,466 ----
$usth->execute;
$usth->finish;
! $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
***************
*** 369,371 ****
--- 473,486 ----
return($amountleft);
}
+
END { } # module clean-up code here (global destructor)
+
+ 1;
+ __END__
+ =back
+
+ =head1 SEE ALSO
+
+ L<DBI(3)|DBI>
+
+ =cut
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Koha-cvs] CVS: koha/C4 Accounts2.pm,1.12,1.13,
Andrew Arensburger <=