praise the parser! amen! (fix a doc typo)

[freeside.git] / FS / FS / part_pkg.pm

diff --git a/FS/FS/part_pkg.pm b/FS/FS/part_pkg.pm
index f650681..3bd559a 100644 (file)
--- a/FS/FS/part_pkg.pm
+++ b/FS/FS/part_pkg.pm
@@ -14,7 +14,7 @@ use FS::type_pkgs;
 use FS::part_pkg_option;
 use FS::pkg_class;
 
-@ISA = qw( FS::Record ); # FS::option_Common ); # this can use option_Common
+@ISA = qw( FS::m2m_Common FS::Record ); # FS::option_Common ); # this can use option_Common
                                                 # when all the plandata bs is
                                                 # gone
 
@@ -81,6 +81,10 @@ inherits from FS::Record.  The following fields are currently supported:
 
 =item disabled - Disabled flag, empty or `Y'
 
+=item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
+
+=item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
+
 =back
 
 =head1 METHODS
@@ -307,6 +311,12 @@ FS::pkg_svc record will be updated.
 sub replace {
   my( $new, $old ) = ( shift, shift );
   my %options = @_;
+
+  # We absolutely have to have an old vs. new record to make this work.
+  if (!defined($old)) {
+    $old = qsearchs( 'part_pkg', { 'pkgpart' => $new->pkgpart } );
+  }
+
   warn "FS::part_pkg::replace called on $new to replace $old ".
        "with options %options"
     if $DEBUG;
@@ -437,6 +447,8 @@ sub check {
     || $self->ut_enum('recurtax', [ '', 'Y' ] )
     || $self->ut_textn('taxclass')
     || $self->ut_enum('disabled', [ '', 'Y' ] )
+    || $self->ut_floatn('pay_weight')
+    || $self->ut_floatn('credit_weight')
     || $self->SUPER::check
   ;
   return $error if $error;
@@ -576,21 +588,23 @@ sub freqs_href {
   #method, class method or sub? #my $self = shift;
 
   tie my %freq, 'Tie::IxHash', 
-    '0'  => '(no recurring fee)',
-    '1h' => 'hourly',
-    '1d' => 'daily',
-    '2d' => 'every two days',
-    '1w' => 'weekly',
-    '2w' => 'biweekly (every 2 weeks)',
-    '1'  => 'monthly',
-    '2'  => 'bimonthly (every 2 months)',
-    '3'  => 'quarterly (every 3 months)',
-    '6'  => 'semiannually (every 6 months)',
-    '12' => 'annually',
-    '24' => 'biannually (every 2 years)',
-    '36' => 'triannually (every 3 years)',
-    '48' => '(every 4 years)',
-    '60' => '(every 5 years)',
+    '0'   => '(no recurring fee)',
+    '1h'  => 'hourly',
+    '1d'  => 'daily',
+    '2d'  => 'every two days',
+    '1w'  => 'weekly',
+    '2w'  => 'biweekly (every 2 weeks)',
+    '1'   => 'monthly',
+    '45d' => 'every 45 days',
+    '2'   => 'bimonthly (every 2 months)',
+    '3'   => 'quarterly (every 3 months)',
+    '6'   => 'semiannually (every 6 months)',
+    '12'  => 'annually',
+    '13'  => 'every 13 months (annually +1 month)',
+    '24'  => 'biannually (every 2 years)',
+    '36'  => 'triannually (every 3 years)',
+    '48'  => '(every 4 years)',
+    '60'  => '(every 5 years)',
     '120' => '(every 10 years)',
   ;
 
@@ -688,7 +702,7 @@ sub option {
   my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
                      split("\n", $self->get('plandata') );
   return $plandata{$opt} if exists $plandata{$opt};
-  cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt".
+  cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
         "not found in options or plandata!\n"
     unless $ornull;
   '';
@@ -803,6 +817,39 @@ sub plan_info {
   \%plans;
 }
 
+=item format OPTION DATA
+
+Returns data formatted according to the function 'format' described
+in the plan info.  Returns DATA if no such function exists.
+
+=cut
+
+sub format {
+  my ($self, $option, $data) = (shift, shift, shift);
+  if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
+    &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
+  }else{
+    $data;
+  }
+}
+
+=item parse OPTION DATA
+
+Returns data parsed according to the function 'parse' described
+in the plan info.  Returns DATA if no such function exists.
+
+=cut
+
+sub parse {
+  my ($self, $option, $data) = (shift, shift, shift);
+  if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
+    &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
+  }else{
+    $data;
+  }
+}
+
+
 =back
 
 =head1 NEW PLAN CLASSES