summaryrefslogtreecommitdiff
path: root/FS/FS/cust_pkg_usageprice.pm
blob: 29e6278820131c6f9e3b6a2b7caa0b6abf448820 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
package FS::cust_pkg_usageprice;
use base qw( FS::Record );

use strict;
use FS::Record qw( dbh ); # qsearch qsearchs );

=head1 NAME

FS::cust_pkg_usageprice - Object methods for cust_pkg_usageprice records

=head1 SYNOPSIS

  use FS::cust_pkg_usageprice;

  $record = new FS::cust_pkg_usageprice \%hash;
  $record = new FS::cust_pkg_usageprice { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::cust_pkg_usageprice object represents an specific customer package usage
pricing add-on.  FS::cust_pkg_usageprice inherits from FS::Record.  The
following fields are currently supported:

=over 4

=item usagepricenum

primary key

=item pkgnum

pkgnum

=item usagepricepart

usagepricepart

=item quantity

quantity


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new record.  To add the record to the database, see L<"insert">.

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'cust_pkg_usageprice'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=item delete

Delete this record from the database.

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=item check

Checks all fields to make sure this is a valid record.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('usagepricenum')
    || $self->ut_number('pkgnum')
    || $self->ut_number('usagepricepart')
    || $self->ut_number('quantity')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item price

Returns the price for this customer usage pricing add-on (quantity of this
record multiplied by price of the associated FS::part_pkg_usageprice record)

=cut

sub price {
  my $self = shift;
  sprintf('%.2f', $self->quantity * $self->part_pkg_usageprice->price);
}

=item apply

Applies this customer usage pricing add-on.  (Mulitplies quantity of this record
by part_pkg_usageprice.amount, and applies to to any services of this package
matching part_pkg_usageprice.target)

If there is an error, returns the error, otherwise returns false.

=cut

sub apply {
  my $self = shift;

  my $oldAutoCommit = $FS::UID::AutoCommit;
  local $FS::UID::AutoCommit = 0;
  my $dbh = dbh;

  my $error = '';

  my $part_pkg_usageprice = $self->part_pkg_usageprice;

  my $amount = $self->quantity * $part_pkg_usageprice->amount;

  my $target = $part_pkg_usageprice->target;

  #these are ongoing counters that count down, so increment them
  if ( $target =~ /^svc_acct.(\w+)$/ ) {

    my $method = "increment_$1";

    foreach my $cust_svc ( $self->cust_pkg->cust_svc(svcdb=>'svc_acct') ) {
      $error ||= $cust_svc->svc_x->$method( $amount );
    }

  #this is a maximum number, not a counter, so we want to take our number
  # and add it to the default for the service
  } elsif ( $target eq 'svc_conferencing.participants' ) {

    foreach my $cust_svc ($self->cust_pkg->cust_svc(svcdb=>'svc_conferencing')){
      my $svc_conferencing = $cust_svc->svc_x;
      my $base_amount = $cust_svc->part_svc->part_svc_column('participants')->columnvalue || 0; #assuming.. D?  F would get overridden  :/
      $svc_conferencing->participants( $base_amount + $amount );
      $error ||= $svc_conferencing->replace;
    }

  #this has no multiplication involved, its just a set only
  #} elsif ( $target eq 'svc_conferencing.confqualitynum' ) {

  
  } elsif ( $target eq 'sqlradacct_hour.recur_included_total' ) {

    $error = "Cannot call apply on target $target";

  }

  if ( $error ) {
    $dbh->rollback if $oldAutoCommit;
  } else {
    $dbh->commit if $oldAutoCommit;
  }
  return $error;

}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::part_pkg_usageprice>, L<FS::cust_pkg>, L<FS::Record>

=cut

1;