summaryrefslogtreecommitdiff
path: root/FS/FS/cust_pkg_reason.pm
blob: 6bd17b66fee9a7c2d5681f4638ce17bbd7a32390 (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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
package FS::cust_pkg_reason;

use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs );

@ISA = qw(FS::Record);

=head1 NAME

FS::cust_pkg_reason - Object methods for cust_pkg_reason records

=head1 SYNOPSIS

  use FS::cust_pkg_reason;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::cust_pkg_reason object represents a relationship between a cust_pkg
and a reason, for example cancellation or suspension reasons. 
FS::cust_pkg_reason inherits from FS::Record.  The following fields are
currently supported:

=over 4

=item num - primary key

=item pkgnum - 

=item reasonnum - 

=item otaker - 

=item date - 


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new cust_pkg_reason.  To add the example 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

sub table { 'cust_pkg_reason'; }

=item insert

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

=cut

=item delete

Delete this record from the database.

=cut

=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.

=cut

=item check

Checks all fields to make sure this is a valid cust_pkg_reason.  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('num')
    || $self->ut_number('pkgnum')
    || $self->ut_number('reasonnum')
    || $self->ut_enum('action', [ 'A', 'C', 'E', 'S' ])
    || $self->ut_text('otaker')
    || $self->ut_numbern('date')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item reason

Returns the reason (see L<FS::reason>) associated with this cust_pkg_reason.

=cut

sub reason {
  my $self = shift;
  qsearchs( 'reason', { 'reasonnum' => $self->reasonnum } );
}

=item reasontext

Returns the text of the reason (see L<FS::reason>) associated with this
cust_pkg_reason.

=cut

sub reasontext {
  my $reason = shift->reason;
  $reason ? $reason->reason : '';
}

# _upgrade_data
#
# Used by FS::Upgrade to migrate to a new database.

sub _upgrade_data { # class method
  my ($class, %opts) = @_;

  my $test_cust_pkg_reason = new FS::cust_pkg_reason;
  return '' unless $test_cust_pkg_reason->dbdef_table->column('action');

  my $count = 0;
  my @unmigrated = qsearch('cust_pkg_reason', { 'action' => '' } ); 
  foreach ( @unmigrated ) {
    # we could create h_cust_pkg_reason and h_cust_pkg_reason packages
    @FS::h_cust_pkg::ISA = qw( FS::h_Common FS::cust_pkg );
    sub FS::h_cust_pkg::table { 'h_cust_pkg' };
    @FS::h_cust_pkg_reason::ISA = qw( FS::h_Common FS::cust_pkg_reason );
    sub FS::h_cust_pkg_reason::table { 'h_cust_pkg_reason' };

    my @history_cust_pkg_reason = qsearch( 'h_cust_pkg_reason', { $_->hash } );
    
    next unless scalar(@history_cust_pkg_reason) == 1;

    my %action_value = ( op    => 'LIKE',
                         value => 'replace_%',
                       );
    my $hashref = { pkgnum => $_->pkgnum,
                    history_date   => $history_cust_pkg_reason[0]->history_date,
                    history_action => { %action_value },
                  };

    my @history = qsearch({ table    => 'h_cust_pkg',
                            hashref  => $hashref,
                            order_by => 'ORDER BY history_action',
                         });

    if (@history < 2) {
      $hashref->{history_date}++;  # more fuzz?
      $hashref->{history_action} = { %action_value }; # qsearch distorts this!
      push @history, qsearch({ table    => 'h_cust_pkg',
                               hashref  => $hashref,
                               order_by => 'ORDER BY history_action',
                            });
    }

    next unless scalar(@history) == 2;

    my @new = grep { $_->history_action eq 'replace_new' } @history;
    my @old = grep { $_->history_action eq 'replace_old' } @history;
    
    next if (scalar(@new) == 2 || scalar(@old) == 2);

    if ( !$old[0]->get('cancel') && $new[0]->get('cancel') ) {
      $_->action('C');
    }elsif( !$old[0]->susp && $new[0]->susp ){
      $_->action('S');
    }elsif( $new[0]->expire &&
            (!$old[0]->expire || !$old[0]->expire != $new[0]->expire )
          ){
      $_->action('E');
    }elsif( $new[0]->adjourn &&
            (!$old[0]->adjourn || $old[0]->adjourn != $new[0]->adjourn )
          ){
      $_->action('A');
    }

    my $error = $_->replace
      if $_->modified;

    die $error if $error;

    $count++;
  }

  #remove nullability if scalar(@migrated) - $count == 0 && ->column('action');
  
  '';

}

=back

=head1 BUGS

Here be termites.  Don't use on wooden computers.

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;