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
|
package FS::reason;
use strict;
use vars qw( @ISA $DEBUG $me );
use DBIx::DBSchema;
use DBIx::DBSchema::Table;
use DBIx::DBSchema::Column;
use FS::Record qw( qsearch qsearchs dbh dbdef );
use FS::reason_type;
@ISA = qw(FS::Record);
$DEBUG = 0;
$me = '[FS::reason]';
=head1 NAME
FS::reason - Object methods for reason records
=head1 SYNOPSIS
use FS::reason;
$record = new FS::reason \%hash;
$record = new FS::reason { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::reason object represents a reason message. FS::reason inherits from
FS::Record. The following fields are currently supported:
=over 4
=item reasonnum - primary key
=item reason_type - index into FS::reason_type
=item reason - text of the reason
=item disabled - 'Y' or ''
=item unsuspend_pkgpart - for suspension reasons only, the pkgpart (see
L<FS::part_pkg>) of a package to be ordered when the package is unsuspended.
Typically this will be some kind of reactivation fee. Attaching it to
a suspension reason allows the reactivation fee to be charged for some
suspensions but not others.
=item unsuspend_hold - 'Y' or ''. If unsuspend_pkgpart is set, this tells
whether to bill the unsuspend package immediately ('') or to wait until
the customer's next invoice ('Y').
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new 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 { '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 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('reasonnum')
|| $self->ut_number('reason_type')
|| $self->ut_foreign_key('reason_type', 'reason_type', 'typenum')
|| $self->ut_text('reason')
|| $self->ut_flag('disabled')
;
return $error if $error;
if ( $self->reasontype->class eq 'S' ) {
$error = $self->ut_numbern('unsuspend_pkgpart')
|| $self->ut_foreign_keyn('unsuspend_pkgpart', 'part_pkg', 'pkgpart')
|| $self->ut_flag('unsuspend_hold')
;
return $error if $error;
} else {
$self->set('unsuspend_pkgpart' => '');
$self->set('unsuspend_hold' => '');
}
$self->SUPER::check;
}
=item reasontype
Returns the reason_type (see L<FS::reason_type>) associated with this reason.
=cut
sub reasontype {
qsearchs( 'reason_type', { 'typenum' => shift->reason_type } );
}
=back
=head1 CLASS METHODS
=over 4
=item new_or_existing reason => REASON, type => TYPE, class => CLASS
Fetches the reason matching these parameters if there is one. If not,
inserts one. Will also insert the reason type if necessary. CLASS must
be one of 'C' (cancel reasons), 'R' (credit reasons), or 'S' (suspend reasons).
This will die if anything fails.
=cut
sub new_or_existing {
my $class = shift;
my %opt = @_;
my $error = '';
my %hash = ('class' => $opt{'class'}, 'type' => $opt{'type'});
my $reason_type = qsearchs('reason_type', \%hash)
|| FS::reason_type->new(\%hash);
$error = $reason_type->insert unless $reason_type->typenum;
die "error inserting reason type: $error\n" if $error;
%hash = ('reason_type' => $reason_type->typenum, 'reason' => $opt{'reason'});
my $reason = qsearchs('reason', \%hash)
|| FS::reason->new(\%hash);
$error = $reason->insert unless $reason->reasonnum;
die "error inserting reason: $error\n" if $error;
$reason;
}
=head1 BUGS
Here by termintes. Don't use on wooden computers.
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
