package FS::cust_event_fee;
+use base qw( FS::Record FS::FeeOrigin_Mixin );
use strict;
-use base qw( FS::Record );
-use FS::Record qw( qsearch qsearchs );
+use FS::Record qw( qsearch dbh );
=head1 NAME
An FS::cust_event_fee object links a billing event that charged a fee
(an L<FS::cust_event>) to the resulting invoice line item (an
-L<FS::cust_bill_pkg> object). FS::cust_event_fee inherits from FS::Record.
-The following fields are currently supported:
+L<FS::cust_bill_pkg> object). FS::cust_event_fee inherits from FS::Record
+and FS::FeeOrigin_Mixin. The following fields are currently supported:
=over 4
=item feepart - key of the fee definition (L<FS::part_fee>).
+=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
=cut
-# the check method should currently be supplied - FS::Record contains some
-# data checking routines
-
sub check {
my $self = shift;
|| $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;
=over 4
-=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.
+=item _by_cust CUSTNUM[, PARAMS]
-PARAMS can be additional params to pass to qsearch; this really only works
-for 'hashref' and 'order_by'.
+See L<FS::FeeOrigin_Mixin/by_cust>. 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 = @_;
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<FS::FeeOrigin_Mixin/cust_bill>. 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<FS::FeeOrigin_Mixin/cust_bill>. 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 '';
+ }
+}
+
+=back
+
+=cut
+
+sub _upgrade_schema {
+ my ($class, %opts) = @_;
+
+ my $sql = '
+ DELETE FROM cust_event_Fee WHERE NOT EXISTS
+ ( SELECT 1 FROM cust_event WHERE cust_event.eventnum = cust_event_fee.eventnum )
+ ';
+
+ my $sth = dbh->prepare($sql) or die dbh->errstr;
+ $sth->execute or die $sth->errstr;
+ '';
+}
+
=head1 BUGS
=head1 SEE ALSO
-L<FS::cust_event>, L<FS::part_fee>, L<FS::Record>
+L<FS::cust_event>, L<FS::FeeOrigin_Mixin>, L<FS::Record>
=cut