X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Freason_Mixin.pm;h=a1b32f2b582504ddee17294bcc37caa9c7108215;hp=95fe3e9f87b6087060c9ee52e999a1b7756083d6;hb=ff27c3f36240aee48ed50153dd5d8fe3ac3f2443;hpb=c82e10e2a7af8039962b3f2bd8df4050977c279c diff --git a/FS/FS/reason_Mixin.pm b/FS/FS/reason_Mixin.pm index 95fe3e9f8..a1b32f2b5 100644 --- a/FS/FS/reason_Mixin.pm +++ b/FS/FS/reason_Mixin.pm @@ -22,13 +22,8 @@ voided payment / voided invoice. This can no longer be used to set the sub reason { my $self = shift; - my $reason_text; - if ( $self->reasonnum ) { - my $reason = FS::reason->by_key($self->reasonnum); - $reason_text = $reason->reason; - } else { # in case one of these somehow still exists - $reason_text = $self->get('reason'); - } + my $reason_text = $self->reason_only; + if ( $self->get('addlinfo') ) { $reason_text .= ' ' . $self->get('addlinfo'); } @@ -36,6 +31,28 @@ sub reason { return $reason_text; } +=item reason_only + +Returns only the text of the associated reason, +absent any addlinfo that is included by L. +(Currently only affects credit and credit void reasons.) + +=cut + +# a bit awkward, but much easier to invoke this in the few reports +# that need separate fields than to update every place +# that displays them together + +sub reason_only { + my $self = shift; + if ( $self->reasonnum ) { + my $reason = FS::reason->by_key($self->reasonnum); + return $reason->reason; + } else { # in case one of these somehow still exists + return $self->get('reason'); + } +} + # Used by FS::Upgrade to migrate reason text fields to reasonnum. # Note that any new tables that get reasonnum fields do NOT need to be # added here unless they have previously had a free-text "reason" field. @@ -45,13 +62,13 @@ sub _upgrade_reasonnum { # class method my $table = $class->table; my $reason_class; - if ( $table eq 'cust_bill' or $table eq 'cust_bill_pkg' ) { + if ( $table =~ /^cust_bill/ ) { # also includes cust_bill_pkg $reason_class = 'I'; - } elsif ( $table eq 'cust_pay' ) { + } elsif ( $table =~ /^cust_pay/ ) { $reason_class = 'P'; } elsif ( $table eq 'cust_refund' ) { $reason_class = 'F'; - } elsif ( $table eq 'cust_credit' ) { + } elsif ( $table =~ /^cust_credit/ ) { $reason_class = 'R'; } else { die "don't know the reason class to use for upgrading $table"; @@ -59,7 +76,7 @@ sub _upgrade_reasonnum { # class method for my $fieldname (qw(reason void_reason)) { - if ( $table eq 'cust_credit' and $fieldname eq 'void_reason' ) { + if ( $table =~ /^cust_credit/ and $fieldname eq 'void_reason' ) { $reason_class = 'X'; } @@ -77,25 +94,23 @@ sub _upgrade_reasonnum { # class method } ); - if ( - scalar( - grep { $_->getfield($fieldname) =~ /\S/ } - @legacy_reason_records - ) - ) - { + if ( @legacy_reason_records ) { + warn "$me Found unmigrated reasons\n" if $DEBUG; my $reason_type = - _upgrade_get_legacy_reason_type( $class, $table ); - my $noreason = _upgrade_get_no_reason( $class, $reason_type ); + $class->_upgrade_get_legacy_reason_type( $reason_class ); + # XXX "noreason" does not actually work, because we limited to + # "reason is not null" above. Records where the reason string + # is null will end up with a reasonnum of null also. + my $noreason = $class->_upgrade_get_no_reason( $reason_type ); foreach my $record_to_upgrade (@legacy_reason_records) { my $reason = $record_to_upgrade->getfield($fieldname); warn "Contemplating reason $reason\n" if $DEBUG > 1; if ( $reason =~ /\S/ ) { my $reason = - _upgrade_get_reason( $class, $reason, $reason_type ); + $class->_upgrade_get_reason( $reason, $reason_type ); $record_to_upgrade->set( $fieldname . 'num', $reason->reasonnum ); } @@ -118,15 +133,14 @@ sub _upgrade_reasonnum { # class method } } +# internal methods for upgrade + # _upgrade_get_legacy_reason_type is class method supposed to be used only # within the reason_Mixin class which will either find or create a reason_type sub _upgrade_get_legacy_reason_type { my $class = shift; - my $table = shift; - - my $reason_class = - ( $table =~ /void/ ) ? 'X' : 'F'; # see FS::reason_type (%class_name) + my $reason_class = shift; my $reason_type_params = { 'class' => $reason_class, 'type' => 'Legacy' }; my $reason_type = qsearchs( 'reason_type', $reason_type_params ); unless ($reason_type) { @@ -145,7 +159,7 @@ sub _upgrade_get_no_reason { my $class = shift; my $reason_type = shift; - return _upgrade_get_reason( $class, '(none)', $reason_type ); + return $class->_upgrade_get_reason( '(none)', $reason_type ); } # _upgrade_get_reason is class method supposed to be used only within the