package FS::cust_refund;
use strict;
-use vars qw( @ISA @encrypted_fields );
+use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
+ FS::Record );
+use vars qw( @encrypted_fields );
use Business::CreditCard;
-use FS::Record qw( qsearch qsearchs dbh );
use FS::UID qw(getotaker);
+use FS::Record qw( qsearch qsearchs dbh );
use FS::cust_credit;
use FS::cust_credit_refund;
use FS::cust_pay_refund;
use FS::cust_main;
-use FS::payinfo_Mixin;
-
-@ISA = qw( FS::Record FS::payinfo_Mixin );
@encrypted_fields = ('payinfo');
=over 4
-=item refundnum - primary key (assigned automatically for new refunds)
+=item refundnum
+
+primary key (assigned automatically for new refunds)
+
+=item custnum
+
+customer (see L<FS::cust_main>)
+
+=item refund
+
+Amount of the refund
-=item custnum - customer (see L<FS::cust_main>)
+=item reason
-=item refund - Amount of the refund
+Reason for the refund
-=item reason - Reason for the refund
+=item _date
-
=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
+specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
L<Time::Local> and L<Date::Parse> for conversion functions.
-=item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
+=item payby
-=item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
+Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
-=item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
+=item payinfo
-=item paybatch - text field for tracking card processing
+Payment Information (See L<FS::payinfo_Mixin> for data format)
-=item otaker - order taker (assigned automatically, see L<FS::UID>)
+=item paymask
-=item closed - books closed flag, empty or `Y'
+Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
+
+=item paybatch
+
+text field for tracking card processing
+
+=item usernum
+
+order taker (see L<FS::access_user>
+
+=item closed
+
+books closed flag, empty or `Y'
=back
=item delete
-Currently unimplemented (accounting reasons).
+Unless the closed flag is set, deletes this refund and all associated
+applications (see L<FS::cust_credit_refund> and L<FS::cust_pay_refund>).
=cut
sub delete {
my $self = shift;
return "Can't delete closed refund" if $self->closed =~ /^Y/i;
- $self->SUPER::delete(@_);
+
+ local $SIG{HUP} = 'IGNORE';
+ local $SIG{INT} = 'IGNORE';
+ local $SIG{QUIT} = 'IGNORE';
+ local $SIG{TERM} = 'IGNORE';
+ local $SIG{TSTP} = 'IGNORE';
+ local $SIG{PIPE} = 'IGNORE';
+
+ my $oldAutoCommit = $FS::UID::AutoCommit;
+ local $FS::UID::AutoCommit = 0;
+ my $dbh = dbh;
+
+ foreach my $cust_credit_refund ( $self->cust_credit_refund ) {
+ my $error = $cust_credit_refund->delete;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return $error;
+ }
+ }
+
+ foreach my $cust_pay_refund ( $self->cust_pay_refund ) {
+ my $error = $cust_pay_refund->delete;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return $error;
+ }
+ }
+
+ my $error = $self->SUPER::delete(@_);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return $error;
+ }
+
+ $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+ '';
+
}
=item replace OLD_RECORD
-Currently unimplemented (accounting reasons).
+Modifying a refund? Well, don't say I didn't warn you.
=cut
sub replace {
- return "Can't (yet?) modify cust_refund records!";
+ my $self = shift;
+ $self->SUPER::replace(@_);
}
=item check
sub check {
my $self = shift;
+ $self->otaker(getotaker) unless $self->otaker;
+
my $error =
$self->ut_numbern('refundnum')
|| $self->ut_numbern('custnum')
|| $self->ut_money('refund')
+ || $self->ut_alphan('otaker')
|| $self->ut_text('reason')
|| $self->ut_numbern('_date')
|| $self->ut_textn('paybatch')
$error = $self->payinfo_check;
return $error if $error;
- $self->otaker(getotaker);
-
$self->SUPER::check;
}
sub cust_credit_refund {
my $self = shift;
+ map { $_ } #return $self->num_cust_credit_refund unless wantarray;
sort { $a->_date <=> $b->_date }
qsearch( 'cust_credit_refund', { 'refundnum' => $self->refundnum } )
;
sub cust_pay_refund {
my $self = shift;
+ map { $_ } #return $self->num_cust_pay_refund unless wantarray;
sort { $a->_date <=> $b->_date }
qsearch( 'cust_pay_refund', { 'refundnum' => $self->refundnum } )
;
sprintf("%.2f", $amount );
}
-=item payinfo_masked
+=back
+
+=head1 CLASS METHODS
-<DEPRICATED> Use $self->paymask
+=over 4
-Returns a "masked" payinfo field with all but the last four characters replaced
-by 'x'es. Useful for displaying credit cards.
+=item unapplied_sql
-=cut
+Returns an SQL fragment to retreive the unapplied amount.
+=cut
+
+sub unapplied_sql {
+ #my $class = shift;
+
+ "refund
+ - COALESCE(
+ ( SELECT SUM(amount) FROM cust_credit_refund
+ WHERE cust_refund.refundnum = cust_credit_refund.refundnum )
+ ,0
+ )
+ - COALESCE(
+ ( SELECT SUM(amount) FROM cust_pay_refund
+ WHERE cust_refund.refundnum = cust_pay_refund.refundnum )
+ ,0
+ )
+ ";
-sub payinfo_masked {
- my $self = shift;
- return $self->paymask;
}
+# Used by FS::Upgrade to migrate to a new database.
+sub _upgrade_data { # class method
+ my ($class, %opts) = @_;
+ $class->_upgrade_otaker(%opts);
+}
=back
=head1 BUGS
-Delete and replace methods. payinfo_masked false laziness with cust_main.pm
-and cust_pay.pm
+Delete and replace methods.
=head1 SEE ALSO
projects / freeside.git / blobdiff