5 use FS::Record qw( qsearch );
8 @ISA = qw( FS::Record );
12 FS::part_pkg - Object methods for part_pkg objects
18 $record = new FS::part_pkg \%hash
19 $record = new FS::part_pkg { 'column' => 'value' };
21 $custom_record = $template_record->clone;
23 $error = $record->insert;
25 $error = $new_record->replace($old_record);
27 $error = $record->delete;
29 $error = $record->check;
31 @pkg_svc = $record->pkg_svc;
33 $svcnum = $record->svcpart;
34 $svcnum = $record->svcpart( 'svc_acct' );
38 An FS::part_pkg object represents a billing item definition. FS::part_pkg
39 inherits from FS::Record. The following fields are currently supported:
43 =item pkgpart - primary key (assigned automatically for new billing item definitions)
45 =item pkg - Text name of this billing item definition (customer-viewable)
47 =item comment - Text name of this billing item definition (non-customer-viewable)
49 =item setup - Setup fee expression
51 =item freq - Frequency of recurring fee
53 =item recur - Recurring fee expression
55 =item setuptax - Setup fee tax exempt flag, empty or `Y'
57 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
59 =item plan - Price plan
61 =item plandata - Price plan data
63 =item disabled - Disabled flag, empty or `Y'
67 setup and recur are evaluated as Safe perl expressions. You can use numbers
68 just as you would normally. More advanced semantics are not yet defined.
76 Creates a new billing item definition. To add the billing item definition to
77 the database, see L<"insert">.
81 sub table { 'part_pkg'; }
85 An alternate constructor. Creates a new billing item definition by duplicating
86 an existing definition. A new pkgpart is assigned and `(CUSTOM) ' is prepended
87 to the comment field. To add the billing item definition to the database, see
94 my $class = ref($self);
95 my %hash = $self->hash;
96 $hash{'pkgpart'} = '';
97 $hash{'comment'} = "(CUSTOM) ". $hash{'comment'}
98 unless $hash{'comment'} =~ /^\(CUSTOM\) /;
99 #new FS::part_pkg ( \%hash ); # ?
100 new $class ( \%hash ); # ?
105 Adds this billing item definition to the database. If there is an error,
106 returns the error, otherwise returns false.
110 Currently unimplemented.
115 return "Can't (yet?) delete package definitions.";
116 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
119 =item replace OLD_RECORD
121 Replaces OLD_RECORD with this one in the database. If there is an error,
122 returns the error, otherwise returns false.
126 Checks all fields to make sure this is a valid billing item definition. If
127 there is an error, returns the error, otherwise returns false. Called by the
128 insert and replace methods.
135 $self->ut_numbern('pkgpart')
136 || $self->ut_text('pkg')
137 || $self->ut_text('comment')
138 || $self->ut_anything('setup')
139 || $self->ut_number('freq')
140 || $self->ut_anything('recur')
141 || $self->ut_alphan('plan')
142 || $self->ut_anything('plandata')
143 || $self->ut_enum('setuptax', [ '', 'Y' ] )
144 || $self->ut_enum('recurtax', [ '', 'Y' ] )
145 || $self->ut_enum('disabled', [ '', 'Y' ] )
152 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
153 definition (with non-zero quantity).
159 grep { $_->quantity } qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
162 =item svcpart [ SVCDB ]
164 Returns the svcpart of a single service definition (see L<FS::part_svc>)
165 associated with this billing item definition (see L<FS::pkg_svc>). Returns
166 false if there not exactly one service definition with quantity 1, or if
167 SVCDB is specified and does not match the svcdb of the service definition,
174 my @pkg_svc = $self->pkg_svc;
175 return '' if scalar(@pkg_svc) != 1
176 || $pkg_svc[0]->quantity != 1
177 || ( $svcdb && $pkg_svc[0]->part_svc->svcdb ne $svcdb );
178 $pkg_svc[0]->svcpart;
185 $Id: part_pkg.pm,v 1.6 2002-01-28 06:57:23 ivan Exp $
189 The delete method is unimplemented.
191 setup and recur semantics are not yet defined (and are implemented in
192 FS::cust_bill. hmm.).
196 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
197 schema.html from the base documentation.