changes to support new invoice template features, #28080

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

diff --git a/FS/FS/cust_bill_pkg_detail.pm b/FS/FS/cust_bill_pkg_detail.pm
index 4d9ee81..d0cbdbe 100644 (file)
--- a/FS/FS/cust_bill_pkg_detail.pm
+++ b/FS/FS/cust_bill_pkg_detail.pm
@@ -55,6 +55,10 @@ inherits from FS::Record.  The following fields are currently supported:
 
 =item phonenum -
 
 
 =item phonenum -
 

+=item accountcode - accountcode
+
+=item startdate - CDR startdate, if any
+

 =item detail - detail description
 
 =back
 =item detail - detail description
 
 =back


@@ -82,27 +86,15 @@ sub table { 'cust_bill_pkg_detail'; }
 Adds this record to the database.  If there is an error, returns the error,
 otherwise returns false.
 
 Adds this record to the database.  If there is an error, returns the error,
 otherwise returns false.
 

-=cut
-
-# the insert method can be inherited from FS::Record
-

 =item delete
 
 Delete this record from the database.
 
 =item delete
 
 Delete this record from the database.
 

-=cut
-
-# the delete method can be inherited from FS::Record
-

 =item replace OLD_RECORD
 
 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
 
 =item replace OLD_RECORD
 
 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
 

-=cut
-
-# the replace method can be inherited from FS::Record
-

 =item check
 
 Checks all fields to make sure this is a valid line item detail.  If there is
 =item check
 
 Checks all fields to make sure this is a valid line item detail.  If there is


@@ -137,9 +129,11 @@ sub check {
     || $self->ut_enum('format', [ '', 'C' ] )
     || $self->ut_numbern('duration')
     || $self->ut_textn('regionname')
     || $self->ut_enum('format', [ '', 'C' ] )
     || $self->ut_numbern('duration')
     || $self->ut_textn('regionname')

+    || $self->ut_textn('accountcode')

     || $self->ut_text('detail')
     || $self->ut_foreign_keyn('classnum', 'usage_class', 'classnum')
     || $self->$phonenum_check_method('phonenum')
     || $self->ut_text('detail')
     || $self->ut_foreign_keyn('classnum', 'usage_class', 'classnum')
     || $self->$phonenum_check_method('phonenum')

+    || $self->ut_numbern('startdate')

     || $self->SUPER::check
     ;
 
     || $self->SUPER::check
     ;
 


@@ -158,11 +152,13 @@ for tabular appearance in those environments if possible.
 If I<escape_function> is set then the format is processed by this
 function before being returned.
 
 If I<escape_function> is set then the format is processed by this
 function before being returned.
 

+DEPRECATED? (mostly unused, expensive)

 If I<format_function> is set then the detail is handed to this callback
 for processing.
 
 =cut
 
 If I<format_function> is set then the detail is handed to this callback
 for processing.
 
 =cut
 

+#totally false laziness w/cust_bill_pkg->detail

 sub formatted {
   my ( $self, %opt ) = @_;
   my $format = $opt{format} || '';
 sub formatted {
   my ( $self, %opt ) = @_;
   my $format = $opt{format} || '';


@@ -230,18 +226,30 @@ sub formatted {
   ;
 }
 
   ;
 }
 

+=item cust_bill_pkg

 
 

-# _upgrade_data
-#
-# Used by FS::Upgrade to migrate to a new database.
+Returns the L<FS::cust_bill_pkg> object (the invoice line item) that
+this detail belongs to.

 
 

-sub _upgrade_data { # class method
+=cut
+
+sub cust_bill_pkg {
+  my $self = shift;
+  my $billpkgnum = $self->billpkgnum or return '';
+  FS::cust_bill_pkg->by_key($billpkgnum);
+}
+
+# Used by FS::Upgrade to migrate to a new database schema
+sub _upgrade_schema { # class method

 
   my ($class, %opts) = @_;
 
   warn "$me upgrading $class\n" if $DEBUG;
 
 
   my ($class, %opts) = @_;
 
   warn "$me upgrading $class\n" if $DEBUG;
 

-  my $type = dbdef->table($class->table)->column('classnum')->type;
+  my $classnum = dbdef->table($class->table)->column('classnum')
+    or return;
+
+  my $type = $classnum->type;

   unless ( $type =~ /^int/i || $type =~ /int$/i ) {
 
     my $dbh = dbh;
   unless ( $type =~ /^int/i || $type =~ /int$/i ) {
 
     my $dbh = dbh;


@@ -313,51 +321,50 @@ sub _upgrade_data { # class method
 
   }
 
 
   }
 

+}
+
+# Used by FS::Upgrade to migrate to a new database
+sub _upgrade_data { # class method

 
 

-  if ( defined( dbdef->table($class->table)->column('billpkgnum') ) &&
-       defined( dbdef->table($class->table)->column('invnum') ) &&
-       defined( dbdef->table($class->table)->column('pkgnum') ) 
-  ) {
-
-    warn "$me Checking for unmigrated invoice line item details\n" if $DEBUG;
-
-    my @cbpd = qsearch({ 'table'   => $class->table,
-                         'hashref' => {},
-                         'extra_sql' => 'WHERE invnum IS NOT NULL AND '.
-                                        'pkgnum IS NOT NULL',
-                      });
-
-    if (scalar(@cbpd)) {
-      warn "$me Found unmigrated invoice line item details\n" if $DEBUG;
-
-      foreach my $cbpd ( @cbpd ) {
-        my $detailnum = $cbpd->detailnum;
-        warn "$me Contemplating detail $detailnum\n" if $DEBUG > 1;
-        my $cust_bill_pkg =
-          qsearchs({ 'table' => 'cust_bill_pkg',
-                     'hashref' => { 'invnum' => $cbpd->invnum,
-                                    'pkgnum' => $cbpd->pkgnum,
-                                  },
-                     'order_by' => 'ORDER BY billpkgnum LIMIT 1',
-                  });
-        if ($cust_bill_pkg) {
-          $cbpd->billpkgnum($cust_bill_pkg->billpkgnum);
-          $cbpd->invnum('');
-          $cbpd->pkgnum('');
-          my $error = $cbpd->replace;
-
-          warn "*** WARNING: error replacing line item detail ".
-               "(cust_bill_pkg_detail) $detailnum: $error ***\n"
-            if $error;
-        } else {
-          warn "Found orphaned line item detail $detailnum during upgrade.\n";
-        }
+  my ($class, %opts) = @_;

 
 

-      } # foreach $cbpd
+  warn "$me Checking for unmigrated invoice line item details\n" if $DEBUG;
+
+  my @cbpd = qsearch({ 'table'   => $class->table,
+                       'hashref' => {},
+                       'extra_sql' => 'WHERE invnum IS NOT NULL AND '.
+                                      'pkgnum IS NOT NULL',
+                    });
+
+  if (scalar(@cbpd)) {
+    warn "$me Found unmigrated invoice line item details\n" if $DEBUG;
+
+    foreach my $cbpd ( @cbpd ) {
+      my $detailnum = $cbpd->detailnum;
+      warn "$me Contemplating detail $detailnum\n" if $DEBUG > 1;
+      my $cust_bill_pkg =
+        qsearchs({ 'table' => 'cust_bill_pkg',
+                   'hashref' => { 'invnum' => $cbpd->invnum,
+                                  'pkgnum' => $cbpd->pkgnum,
+                                },
+                   'order_by' => 'ORDER BY billpkgnum LIMIT 1',
+                });
+      if ($cust_bill_pkg) {
+        $cbpd->billpkgnum($cust_bill_pkg->billpkgnum);
+        $cbpd->invnum('');
+        $cbpd->pkgnum('');
+        my $error = $cbpd->replace;
+
+        warn "*** WARNING: error replacing line item detail ".
+             "(cust_bill_pkg_detail) $detailnum: $error ***\n"
+          if $error;
+      } else {
+        warn "Found orphaned line item detail $detailnum during upgrade.\n";
+      }

 
 

-    } # if @cbpd
+    } # foreach $cbpd

 
 

-  } # if billpkgnum, invnum, and pkgnum columns defined
+  } # if @cbpd

 
   '';
 
 
   '';