FS/FS/cust_pkg_discount.pm

   1 package FS::cust_pkg_discount;
   2
   3 use strict;
   4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Record );
   5 use FS::Record qw( dbh qsearchs ); # qsearch );
   6 use FS::cust_pkg;
   7 use FS::discount;
   8
   9 =head1 NAME
  10
  11 FS::cust_pkg_discount - Object methods for cust_pkg_discount records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_pkg_discount;
  16
  17   $record = new FS::cust_pkg_discount \%hash;
  18   $record = new FS::cust_pkg_discount { 'column' => 'value' };
  19
  20   $error = $record->insert;
  21
  22   $error = $new_record->replace($old_record);
  23
  24   $error = $record->delete;
  25
  26   $error = $record->check;
  27
  28 =head1 DESCRIPTION
  29
  30 An FS::cust_pkg_discount object represents the application of a discount to a
  31 customer package.  FS::cust_pkg_discount inherits from FS::Record.  The
  32 following fields are currently supported:
  33
  34 =over 4
  35
  36 =item pkgdiscountnum
  37
  38 primary key
  39
  40 =item pkgnum
  41
  42 Customer package (see L<FS::cust_pkg>)
  43
  44 =item discountnum
  45
  46 Discount (see L<FS::discount>)
  47
  48 =item months_used
  49
  50 months_used
  51
  52 =item end_date
  53
  54 end_date
  55
  56 =item usernum
  57
  58 order taker, see L<FS::access_user>
  59
  60
  61 =back
  62
  63 =head1 METHODS
  64
  65 =over 4
  66
  67 =item new HASHREF
  68
  69 Creates a new discount application.  To add the record to the database, see
  70  L<"insert">.
  71
  72 Note that this stores the hash reference, not a distinct copy of the hash it
  73 points to.  You can ask the object for a copy with the I<hash> method.
  74
  75 =cut
  76
  77 # the new method can be inherited from FS::Record, if a table method is defined
  78
  79 sub table { 'cust_pkg_discount'; }
  80
  81 =item insert
  82
  83 Adds this record to the database.  If there is an error, returns the error,
  84 otherwise returns false.
  85
  86 =cut
  87
  88 sub insert {
  89   #my( $self, %options ) = @_;
  90   my $self = shift;
  91
  92   local $SIG{HUP} = 'IGNORE';
  93   local $SIG{INT} = 'IGNORE';
  94   local $SIG{QUIT} = 'IGNORE';
  95   local $SIG{TERM} = 'IGNORE';
  96   local $SIG{TSTP} = 'IGNORE';
  97   local $SIG{PIPE} = 'IGNORE';
  98
  99   my $oldAutoCommit = $FS::UID::AutoCommit;
 100   local $FS::UID::AutoCommit = 0;
 101   my $dbh = dbh;
 102
 103   if ( $self->discountnum == -1 ) {
 104     my $discount = new FS::discount {
 105       '_type'    => $self->_type,
 106       'amount'   => $self->amount,
 107       'percent'  => $self->percent,
 108       'months'   => $self->months,
 109       'disabled' => 'Y',
 110     };
 111     my $error = $discount->insert;
 112     if ( $error ) {
 113       $dbh->rollback if $oldAutoCommit;
 114       return $error;
 115     }
 116     $self->discountnum($discount->discountnum);
 117   }
 118
 119   my $error = $self->SUPER::insert; #(@_); #(%options);
 120   if ( $error ) {
 121     $dbh->rollback if $oldAutoCommit;
 122     return $error;
 123   }
 124
 125   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 126   '';
 127
 128 }
 129
 130 =item delete
 131
 132 Delete this record from the database.
 133
 134 =cut
 135
 136 # the delete method can be inherited from FS::Record
 137
 138 =item replace OLD_RECORD
 139
 140 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 141 returns the error, otherwise returns false.
 142
 143 =cut
 144
 145 # the replace method can be inherited from FS::Record
 146
 147 =item check
 148
 149 Checks all fields to make sure this is a valid discount applciation.  If there
 150 is an error, returns the error, otherwise returns false.  Called by the insert
 151 and replace methods.
 152
 153 =cut
 154
 155 # the check method should currently be supplied - FS::Record contains some
 156 # data checking routines
 157
 158 sub check {
 159   my $self = shift;
 160
 161   my $error =
 162     $self->ut_numbern('pkgdiscountnum')
 163     || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum')
 164     || $self->ut_foreign_key('discountnum', 'discount', 'discountnum' )
 165     || $self->ut_float('months_used') #actually decimal, but this will do
 166     || $self->ut_numbern('end_date')
 167     || $self->ut_alphan('otaker')
 168     || $self->ut_enum('disabled', [ '', 'Y' ] )
 169   ;
 170   return $error if $error;
 171
 172   $self->SUPER::check;
 173 }
 174
 175 =item cust_pkg
 176
 177 Returns the customer package (see L<FS::cust_pkg>).
 178
 179 =cut
 180
 181 sub cust_pkg {
 182   my $self = shift;
 183   qsearchs('cust_pkg', { 'pkgnum' => $self->pkgnum } );
 184 }
 185
 186 =item discount
 187
 188 Returns the discount (see L<FS::discount>).
 189
 190 =cut
 191
 192 sub discount {
 193   my $self = shift;
 194   qsearchs('discount', { 'discountnum' => $self->discountnum } );
 195 }
 196
 197 =item increment_months_used
 198
 199 Increments months_used by the given parameter
 200
 201 =cut
 202
 203 sub increment_months_used {
 204   my( $self, $used ) = @_;
 205   #UPDATE cust_pkg_discount SET months_used = months_used + ?
 206   #leaves no history, and billing is mutexed per-customer, so the dum way is ok
 207   $self->months_used( $self->months_used + $used );
 208   $self->replace();
 209 }
 210
 211 =item status
 212
 213 =cut
 214
 215 sub status {
 216   my $self = shift;
 217   my $discount = $self->discount;
 218
 219   if ( $self->disabled ne 'Y'
 220        and ( ! $discount->months || $self->months_used < $discount->months )
 221              #XXX also end date
 222      ) {
 223     'active';
 224   } else {
 225     'expired';
 226   }
 227 }
 228
 229 # Used by FS::Upgrade to migrate to a new database.
 230 sub _upgrade_data {  # class method
 231   my ($class, %opts) = @_;
 232   $class->_upgrade_otaker(%opts);
 233 }
 234
 235 =back
 236
 237 =head1 BUGS
 238
 239 =head1 SEE ALSO
 240
 241 L<FS::discount>, L<FS::cust_pkg>, L<FS::Record>, schema.html from the base documentation.
 242
 243 =cut
 244
 245 1;
 246