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
|
package FS::part_pkg;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch );
use FS::pkg_svc;
@ISA = qw( FS::Record );
=head1 NAME
FS::part_pkg - Object methods for part_pkg objects
=head1 SYNOPSIS
use FS::part_pkg;
$record = new FS::part_pkg \%hash
$record = new FS::part_pkg { 'column' => 'value' };
$custom_record = $template_record->clone;
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
@pkg_svc = $record->pkg_svc;
$svcnum = $record->svcpart;
$svcnum = $record->svcpart( 'svc_acct' );
=head1 DESCRIPTION
An FS::part_pkg object represents a billing item definition. FS::part_pkg
inherits from FS::Record. The following fields are currently supported:
=over 4
=item pkgpart - primary key (assigned automatically for new billing item definitions)
=item pkg - Text name of this billing item definition (customer-viewable)
=item comment - Text name of this billing item definition (non-customer-viewable)
=item setup - Setup fee
=item freq - Frequency of recurring fee
=item recur - Recurring fee
=back
setup and recur are evaluated as Safe perl expressions. You can use numbers
just as you would normally. More advanced semantics are not yet defined.
=head1 METHODS
=over 4
=item new HASHREF
Creates a new billing item definition. To add the billing item definition to
the database, see L<"insert">.
=cut
sub table { 'part_pkg'; }
=item clone
An alternate constructor. Creates a new billing item definition by duplicating
an existing definition. A new pkgpart is assigned and `(CUSTOM) ' is prepended
to the comment field. To add the billing item definition to the database, see
L<"insert">.
=cut
sub clone {
my $self = shift;
my $class = ref($self);
my %hash = $self->hash;
$hash{'pkgpart'} = '';
$hash{'comment'} = "(CUSTOM) ". $hash{'comment'}
unless $hash{'comment'} =~ /^\(CUSTOM\) /;
#new FS::part_pkg ( \%hash ); # ?
new $class ( \%hash ); # ?
}
=item insert
Adds this billing item definition to the database. If there is an error,
returns the error, otherwise returns false.
=item delete
Currently unimplemented.
=cut
sub delete {
return "Can't (yet?) delete package definitions.";
# check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
}
=item replace OLD_RECORD
Replaces 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 billing item definition. If
there is an error, returns the error, otherwise returns false. Called by the
insert and replace methods.
=cut
sub check {
my $self = shift;
$self->ut_numbern('pkgpart')
|| $self->ut_text('pkg')
|| $self->ut_text('comment')
|| $self->ut_anything('setup')
|| $self->ut_number('freq')
|| $self->ut_anything('recur')
;
}
=item pkg_svc
Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
definition.
=cut
sub pkg_svc {
my $self = shift;
qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
}
=item svcpart [ SVCDB ]
Returns the svcpart of a single service definition (see L<FS::part_svc>)
associated with this billing item definition (see L<FS::pkg_svc>). Returns
false if there not exactly one service definition with quantity 1, or if
SVCDB is specified and does not match the svcdb of the service definition,
=cut
sub svcpart {
my $self = shift;
my $svcdb = shift;
my @pkg_svc = $self->pkg_svc;
return '' if scalar(@pkg_svc) != 1
|| $pkg_svc[0]->quantity != 1
|| ( $svcdb && $pkg_svc[0]->part_svc->svcdb ne $svcdb );
$pkg_svc[0]->svcpart;
}
=back
=head1 VERSION
$Id: part_pkg.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $
=head1 BUGS
The delete method is unimplemented.
setup and recur semantics are not yet defined (and are implemented in
FS::cust_bill. hmm.).
=head1 SEE ALSO
L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
schema.html from the base documentation.
=cut
1;
|
