5 use FS::Record qw( qsearch qsearchs fields dbh );
6 use FS::part_svc_column;
11 @ISA = qw(FS::Record);
15 FS::part_svc - Object methods for part_svc objects
21 $record = new FS::part_svc \%hash
22 $record = new FS::part_svc { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::part_svc represents a service definition. FS::part_svc inherits from
35 FS::Record. The following fields are currently supported:
39 =item svcpart - primary key (assigned automatically for new service definitions)
41 =item svc - text name of this service definition
43 =item svcdb - table used for this service. See L<FS::svc_acct>,
44 L<FS::svc_domain>, and L<FS::svc_forward>, among others.
46 =item disabled - Disabled flag, empty or `Y'
56 Creates a new service definition. To add the service definition to the
57 database, see L<"insert">.
61 sub table { 'part_svc'; }
63 =item insert EXTRA_FIELDS_ARRAYREF
65 Adds this service definition to the database. If there is an error, returns
66 the error, otherwise returns false.
70 =item I<svcdb>__I<field> - Default or fixed value for I<field> in I<svcdb>.
72 =item I<svcdb>__I<field>_flag - defines I<svcdb>__I<field> action: null, `D' for default, or `F' for fixed. For virtual fields, can also be 'X' for excluded.
74 TODOC: EXTRA_FIELDS_ARRAYREF
81 @fields = @{shift(@_)} if @_;
83 local $SIG{HUP} = 'IGNORE';
84 local $SIG{INT} = 'IGNORE';
85 local $SIG{QUIT} = 'IGNORE';
86 local $SIG{TERM} = 'IGNORE';
87 local $SIG{TSTP} = 'IGNORE';
88 local $SIG{PIPE} = 'IGNORE';
90 my $oldAutoCommit = $FS::UID::AutoCommit;
91 local $FS::UID::AutoCommit = 0;
94 my $error = $self->SUPER::insert;
96 $dbh->rollback if $oldAutoCommit;
100 my $svcdb = $self->svcdb;
101 # my @rows = map { /^${svcdb}__(.*)$/; $1 }
103 # grep /^${svcdb}__/,
104 # fields('part_svc');
106 grep { $_ ne 'svcnum'
107 && defined( $self->getfield($svcdb.'__'.$_.'_flag') )
108 } (fields($svcdb), @fields)
110 my $part_svc_column = $self->part_svc_column($field);
111 my $previous = qsearchs('part_svc_column', {
112 'svcpart' => $self->svcpart,
113 'columnname' => $field,
116 my $flag = $self->getfield($svcdb.'__'.$field.'_flag');
117 if ( uc($flag) =~ /^([DFX])$/ ) {
118 $part_svc_column->setfield('columnflag', $1);
119 $part_svc_column->setfield('columnvalue',
120 $self->getfield($svcdb.'__'.$field)
123 $error = $part_svc_column->replace($previous);
125 $error = $part_svc_column->insert;
128 $error = $previous ? $previous->delete : '';
131 $dbh->rollback if $oldAutoCommit;
137 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
144 Currently unimplemented.
149 return "Can't (yet?) delete service definitions.";
150 # check & make sure the svcpart isn't in cust_svc or pkg_svc (in any packages)?
153 =item replace OLD_RECORD [ '1.3-COMPAT' [ , EXTRA_FIELDS_ARRAYREF ] ]
155 Replaces OLD_RECORD with this one in the database. If there is an error,
156 returns the error, otherwise returns false.
160 TODOC: EXTRA_FIELDS_ARRAYREF
165 my ( $new, $old ) = ( shift, shift );
167 return "Can't change svcdb for an existing service definition!"
168 unless $old->svcdb eq $new->svcdb;
170 local $SIG{HUP} = 'IGNORE';
171 local $SIG{INT} = 'IGNORE';
172 local $SIG{QUIT} = 'IGNORE';
173 local $SIG{TERM} = 'IGNORE';
174 local $SIG{TSTP} = 'IGNORE';
175 local $SIG{PIPE} = 'IGNORE';
177 my $oldAutoCommit = $FS::UID::AutoCommit;
178 local $FS::UID::AutoCommit = 0;
181 my $error = $new->SUPER::replace( $old );
183 $dbh->rollback if $oldAutoCommit;
187 if ( @_ && $_[0] eq '1.3-COMPAT' ) {
190 @fields = @{shift(@_)} if @_;
192 my $svcdb = $new->svcdb;
194 grep { $_ ne 'svcnum'
195 && defined( $new->getfield($svcdb.'__'.$_.'_flag') )
196 } (fields($svcdb),@fields)
198 my $part_svc_column = $new->part_svc_column($field);
199 my $previous = qsearchs('part_svc_column', {
200 'svcpart' => $new->svcpart,
201 'columnname' => $field,
204 my $flag = $new->getfield($svcdb.'__'.$field.'_flag');
205 if ( uc($flag) =~ /^([DFX])$/ ) {
206 $part_svc_column->setfield('columnflag', $1);
207 $part_svc_column->setfield('columnvalue',
208 $new->getfield($svcdb.'__'.$field)
211 $error = $part_svc_column->replace($previous);
213 $error = $part_svc_column->insert;
216 $error = $previous ? $previous->delete : '';
219 $dbh->rollback if $oldAutoCommit;
224 $dbh->rollback if $oldAutoCommit;
225 return 'non-1.3-COMPAT interface not yet written';
229 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
236 Checks all fields to make sure this is a valid service definition. If there is
237 an error, returns the error, otherwise returns false. Called by the insert
244 my $recref = $self->hashref;
248 $self->ut_numbern('svcpart')
249 || $self->ut_text('svc')
250 || $self->ut_alpha('svcdb')
251 || $self->ut_enum('disabled', [ '', 'Y' ] )
253 return $error if $error;
255 my @fields = eval { fields( $recref->{svcdb} ) }; #might die
256 return "Unknown svcdb!" unless @fields;
261 =item part_svc_column COLUMNNAME
263 Returns the part_svc_column object (see L<FS::part_svc_column>) for the given
264 COLUMNNAME, or a new part_svc_column object if none exists.
268 sub part_svc_column {
269 my( $self, $columnname) = @_;
271 qsearchs('part_svc_column', {
272 'svcpart' => $self->svcpart,
273 'columnname' => $columnname,
275 ) or new FS::part_svc_column {
276 'svcpart' => $self->svcpart,
277 'columnname' => $columnname,
281 =item all_part_svc_column
285 sub all_part_svc_column {
287 qsearch('part_svc_column', { 'svcpart' => $self->svcpart } );
290 =item part_export [ EXPORTTYPE ]
292 Returns all exports (see L<FS::part_export>) for this service, or, if an
293 export type is specified, only returns exports of the given type.
300 $search{'exporttype'} = shift if @_;
301 map { qsearchs('part_export', { 'exportnum' => $_->exportnum, %search } ) }
302 qsearch('export_svc', { 'svcpart' => $self->svcpart } );
307 Returns a list of associated FS::cust_svc records.
313 qsearch('cust_svc', { 'svcpart' => $self->svcpart } );
318 Returns a list of associated FS::svc_* records.
324 map { $_->svc_x } $self->cust_svc;
331 Delete is unimplemented.
333 The list of svc_* tables is hardcoded. When svc_acct_pop is renamed, this
336 all_part_svc_column method should be documented
340 L<FS::Record>, L<FS::part_svc_column>, L<FS::part_pkg>, L<FS::pkg_svc>,
341 L<FS::cust_svc>, L<FS::svc_acct>, L<FS::svc_forward>, L<FS::svc_domain>,
342 schema.html from the base documentation.