site_perl/cust_main_invoice.pm

   1 package FS::cust_main_invoice;
   2
   3 use strict;
   4 use vars qw(@ISA $conf $mydomain);
   5 use Exporter;
   6 use FS::Record qw( qsearchs );
   7 use FS::Conf;
   8 use FS::cust_main;
   9 use FS::svc_acct;
  10
  11 @ISA = qw( FS::Record );
  12
  13 #ask FS::UID to run this stuff for us later
  14 $FS::UID::callback{'FS::cust_main_invoice'} = sub {
  15   $conf = new FS::Conf;
  16   $mydomain = $conf->config('domain');
  17 };
  18
  19 =head1 NAME
  20
  21 FS::cust_main_invoice - Object methods for cust_main_invoice records
  22
  23 =head1 SYNOPSIS
  24
  25   use FS::cust_main_invoice;
  26
  27   $record = new FS::cust_main_invoice \%hash;
  28   $record = new FS::cust_main_invoice { 'column' => 'value' };
  29
  30   $error = $record->insert;
  31
  32   $error = $new_record->replace($old_record);
  33
  34   $error = $record->delete;
  35
  36   $error = $record->check;
  37
  38   $email_address = $record->address;
  39
  40 =head1 DESCRIPTION
  41
  42 An FS::cust_main_invoice object represents an invoice destination.  FS::cust_main_invoice inherits from
  43 FS::Record.  The following fields are currently supported:
  44
  45 =over 4
  46
  47 =item destnum - primary key
  48
  49 =item custnum - customer (see L<FS::cust_main>)
  50
  51 =item dest - Invoice destination: If numeric, a <a href="#svc_acct">svcnum</a>, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist)
  52
  53 =back
  54
  55 =head1 METHODS
  56
  57 =over 4
  58
  59 =item new HASHREF
  60
  61 Creates a new invoice destination.  To add the invoice destination to the database, see L<"insert">.
  62
  63 Note that this stores the hash reference, not a distinct copy of the hash it
  64 points to.  You can ask the object for a copy with the I<hash> method.
  65
  66 =cut
  67
  68 sub table { 'cust_main_invoice'; }
  69
  70 =item insert
  71
  72 Adds this record to the database.  If there is an error, returns the error,
  73 otherwise returns false.
  74
  75 =item delete
  76
  77 Delete this record from the database.
  78
  79 =item replace OLD_RECORD
  80
  81 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  82 returns the error, otherwise returns false.
  83
  84 =cut
  85
  86 sub replace {
  87   my ( $new, $old ) = ( shift, shift );
  88
  89   return "Can't change custnum!" unless $old->custnum eq $new->custnum;
  90
  91   $new->SUPER::replace;
  92 }
  93
  94
  95 =item check
  96
  97 Checks all fields to make sure this is a valid invoice destination.  If there is
  98 an error, returns the error, otherwise returns false.  Called by the insert
  99 and repalce methods.
 100
 101 =cut
 102
 103 sub check {
 104   my $self = shift;
 105
 106   my $error = $self->ut_number('destnum')
 107         or $self->ut_number('custnum')
 108         or $self->ut_text('dest')
 109   ;
 110   return $error if $error;
 111
 112   return "Unknown customer"
 113     unless qsearchs('cust_main',{ 'custnum' => $self->custnum });
 114
 115   if ( $self->dest eq 'POST' ) {
 116     #contemplate our navel
 117   } elsif ( $self->dest =~ /^(\d+)$/ ) {
 118     return "Unknown local account (specified by svcnum)"
 119       unless qsearchs( 'svc_acct', { 'svcnum' => $self->dest } );
 120   } elsif ( $self->dest =~ /^([\w\.\-]+)\@(([\w\.\-]\.)+\w+)$/ ) {
 121     my($user, $domain) = ($1, $2);
 122     if ( $domain eq $mydomain ) {
 123       my $svc_acct = qsearchs( 'svc_acct', { 'username' => $user } );
 124       return "Unknown local account (specified literally)" unless $svc_acct;
 125       $svc_acct->svcnum =~ /^(\d+)$/ or die "Non-numeric svcnum?!";
 126       $self->dest($1);
 127     }
 128   } else {
 129     return "Illegal destination!";
 130   }
 131
 132   ''; #no error
 133 }
 134
 135 =item address
 136
 137 Returns the literal email address for this record (or `POST').
 138
 139 =cut
 140
 141 sub address {
 142   my $self = shift;
 143   if ( $self->dest =~ /(\d+)$/ ) {
 144     my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $1 } );
 145     $svc_acct->username . '@' . $mydomain;
 146   } else {
 147     $self->dest;
 148   }
 149 }
 150
 151 =back
 152
 153 =head1 VERSION
 154
 155 $Id: cust_main_invoice.pm,v 1.3 1998-12-29 11:59:42 ivan Exp $
 156
 157 =head1 BUGS
 158
 159 =head1 SEE ALSO
 160
 161 L<FS::Record>, L<FS::cust_main>
 162
 163 =head1 HISTORY
 164
 165 ivan@voicenet.com 97-jul-1
 166
 167 added hfields
 168 ivan@sisd.com 97-nov-13
 169
 170 $Log: cust_main_invoice.pm,v $
 171 Revision 1.3  1998-12-29 11:59:42  ivan
 172 mostly properly OO, some work still to be done with svc_ stuff
 173
 174 Revision 1.2  1998/12/16 09:58:53  ivan
 175 library support for editing email invoice destinations (not in sub collect yet)
 176
 177 Revision 1.1  1998/12/16 07:40:02  ivan
 178 new table
 179
 180 Revision 1.3  1998/11/15 04:33:00  ivan
 181 updates for newest versoin
 182
 183 Revision 1.2  1998/11/15 03:48:49  ivan
 184 update for current version
 185
 186
 187 =cut
 188
 189 1;
 190