X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_event_fee.pm;h=375a533e96667558aa4f3dd5e91fd3f9621f459b;hb=3cbdd85a96348a287623e3b97c937c7749e99392;hp=78794fdfefdd2717056f504a3e0b7dcf8477c126;hpb=439d00a59c67a7d9d53b5d89c14ab332be16e38b;p=freeside.git diff --git a/FS/FS/cust_event_fee.pm b/FS/FS/cust_event_fee.pm index 78794fdfe..375a533e9 100644 --- a/FS/FS/cust_event_fee.pm +++ b/FS/FS/cust_event_fee.pm @@ -1,7 +1,7 @@ package FS::cust_event_fee; use strict; -use base qw( FS::Record ); +use base qw( FS::Record FS::FeeOrigin_Mixin ); use FS::Record qw( qsearch qsearchs ); =head1 NAME @@ -27,8 +27,8 @@ FS::cust_event_fee - Object methods for cust_event_fee records An FS::cust_event_fee object links a billing event that charged a fee (an L) to the resulting invoice line item (an -L object). FS::cust_event_fee inherits from FS::Record. -The following fields are currently supported: +L object). FS::cust_event_fee inherits from FS::Record +and FS::FeeOrigin_Mixin. The following fields are currently supported: =over 4 @@ -45,6 +45,9 @@ time billing runs for the customer. =item feepart - key of the fee definition (L). +=item nextbill - 'Y' if the fee should be charged on the customer's next +bill, rather than causing a bill to be produced immediately. + =back =head1 METHODS @@ -82,9 +85,6 @@ and replace methods. =cut -# the check method should currently be supplied - FS::Record contains some -# data checking routines - sub check { my $self = shift; @@ -93,6 +93,7 @@ sub check { || $self->ut_foreign_key('eventnum', 'cust_event', 'eventnum') || $self->ut_foreign_keyn('billpkgnum', 'cust_bill_pkg', 'billpkgnum') || $self->ut_foreign_key('feepart', 'part_fee', 'feepart') + || $self->ut_flag('nextbill') ; return $error if $error; @@ -105,17 +106,14 @@ sub check { =over 4 -=item by_cust CUSTNUM[, PARAMS] +=item _by_cust CUSTNUM[, PARAMS] -Finds all cust_event_fee records belonging to the customer CUSTNUM. Currently -fee events can be cust_main or cust_bill events; this will return both. - -PARAMS can be additional params to pass to qsearch; this really only works -for 'hashref' and 'order_by'. +See L. This is the implementation for +event-triggered fees. =cut -sub by_cust { +sub _by_cust { my $class = shift; my $custnum = shift or return; my %params = @_; @@ -141,16 +139,66 @@ sub by_cust { extra_sql => "$where eventtable = 'cust_bill' ". "AND cust_bill.custnum = $custnum", %params + }), + qsearch({ + table => 'cust_event_fee', + addl_from => 'JOIN cust_event USING (eventnum) ' . + 'JOIN part_event USING (eventpart) ' . + 'JOIN cust_pay_batch ON (cust_event.tablenum = cust_pay_batch.paybatchnum)', + extra_sql => "$where eventtable = 'cust_pay_batch' ". + "AND cust_pay_batch.custnum = $custnum", + %params + }), + qsearch({ + table => 'cust_event_fee', + addl_from => 'JOIN cust_event USING (eventnum) ' . + 'JOIN part_event USING (eventpart) ' . + 'JOIN cust_pkg ON (cust_event.tablenum = cust_pkg.pkgnum)', + extra_sql => "$where eventtable = 'cust_pkg' ". + "AND cust_pkg.custnum = $custnum", + %params }) } - +=item cust_bill + +See L. This version simply returns the event +object if the event is an invoice event. + +=cut + +sub cust_bill { + my $self = shift; + my $object = $self->cust_event->cust_X; + if ( $object->isa('FS::cust_bill') ) { + return $object; + } else { + return ''; + } +} + +=item cust_pkg + +See L. This version simply returns the event +object if the event is a package event. + +=cut + +sub cust_pkg { + my $self = shift; + my $object = $self->cust_event->cust_X; + if ( $object->isa('FS::cust_pkg') ) { + return $object; + } else { + return ''; + } +} =head1 BUGS =head1 SEE ALSO -L, L, L +L, L, L =cut