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
|
package FS::cgp_rule;
use strict;
use base qw( FS::o2m_Common FS::Record );
use FS::Record qw( qsearch qsearchs dbh );
use FS::cust_svc;
use FS::cgp_rule_condition;
use FS::cgp_rule_action;
=head1 NAME
FS::cgp_rule - Object methods for cgp_rule records
=head1 SYNOPSIS
use FS::cgp_rule;
$record = new FS::cgp_rule \%hash;
$record = new FS::cgp_rule { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cgp_rule object represents a mail filtering rule. FS::cgp_rule
inherits from FS::Record. The following fields are currently supported:
=over 4
=item rulenum
primary key
=item name
name
=item comment
comment
=item svcnum
svcnum
=item priority
priority
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new rule. To add the rule 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 { 'cgp_rule'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
sub delete {
my $self = shift;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my @del = $self->cgp_rule_condition;
push @del, $self->cgp_rule_action;
foreach my $del (@del) {
my $error = $del->delete;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
my $error = $self->SUPER::delete(@_);
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
}
=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
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid rule. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('rulenum')
|| $self->ut_text('name')
|| $self->ut_textn('comment')
|| $self->ut_foreign_key('svcnum', 'cust_svc', 'svcnum')
|| $self->ut_number('priority')
;
return $error if $error;
$self->SUPER::check;
}
=item cust_svc
=cut
sub cust_svc {
my $self = shift;
qsearchs('cust_svc', { 'svcnum' => $self->svcnum } );
}
=item cgp_rule_condition
Returns the conditions associated with this rule, as FS::cgp_rule_condition
objects.
=cut
sub cgp_rule_condition {
my $self = shift;
qsearch('cgp_rule_condition', { 'rulenum' => $self->rulenum } );
}
=item cgp_rule_action
Returns the actions associated with this rule, as FS::cgp_rule_action
objects.
=cut
sub cgp_rule_action {
my $self = shift;
qsearch('cgp_rule_action', { 'rulenum' => $self->rulenum } );
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
