diff options
Diffstat (limited to 'site_perl/part_pkg.pm')
-rw-r--r-- | site_perl/part_pkg.pm | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/site_perl/part_pkg.pm b/site_perl/part_pkg.pm new file mode 100644 index 000000000..d1c12e47e --- /dev/null +++ b/site_perl/part_pkg.pm @@ -0,0 +1,168 @@ +package FS::part_pkg; + +use strict; +use vars qw(@ISA @EXPORT_OK); +use Exporter; +use FS::Record qw(fields hfields); + +@ISA = qw(FS::Record Exporter); +@EXPORT_OK = qw(hfields fields); + +=head1 NAME + +FS::part_pkg - Object methods for part_pkg objects + +=head1 SYNOPSIS + + use FS::part_pkg; + + $record = create FS::part_pkg \%hash + $record = create FS::part_pkg { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::part_pkg 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 create HASHREF + +Creates a new billing item definition. To add the billing item definition to +the database, see L<"insert">. + +=cut + +sub create { + my($proto,$hashref)=@_; + + #now in FS::Record::new + #my($field); + #foreach $field (fields('part_pkg')) { + # $hashref->{$field}='' unless defined $hashref->{$field}; + #} + + $proto->new('part_pkg',$hashref); +} + +=item insert + +Adds this billing item definition to the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +sub insert { + my($self)=@_; + + $self->check or + $self->add; +} + +=item delete + +Currently unimplemented. + +=cut + +sub delete { + return "Can't (yet?) delete package definitions."; +# maybe check & make sure the pkgpart isn't in cust_pkg or type_pkgs? +# my($self)=@_; +# +# $self->del; +} + +=item replace OLD_RECORD + +Replaces OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +sub replace { + my($new,$old)=@_; + return "(Old) Not a part_pkg record!" unless $old->table eq "part_pkg"; + return "Can't change pkgpart!" + unless $old->getfield('pkgpart') eq $new->getfield('pkgpart'); + $new->check or + $new->rep($old); +} + +=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)=@_; + return "Not a part_pkg record!" unless $self->table eq "part_pkg"; + + $self->ut_numbern('pkgpart') + or $self->ut_text('pkg') + or $self->ut_text('comment') + or $self->ut_anything('setup') + or $self->ut_number('freq') + or $self->ut_anything('recur') + ; + +} + +=back + +=head1 BUGS + +It doesn't properly override FS::Record yet. + +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. + +=head1 HISTORY + +ivan@sisd.com 97-dec-5 + +pod ivan@sisd.com 98-sep-21 + +=cut + +1; + |