FS/FS/prepay_credit.pm

   1 package FS::prepay_credit;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw(qsearchs dbh);
   6 use FS::agent;
   7
   8 @ISA = qw(FS::Record);
   9
  10 =head1 NAME
  11
  12 FS::prepay_credit - Object methods for prepay_credit records
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::prepay_credit;
  17
  18   $record = new FS::prepay_credit \%hash;
  19   $record = new FS::prepay_credit {
  20     'identifier' => '4198123455512121'
  21     'amount'     => '19.95',
  22   };
  23
  24   $record = new FS::prepay_credit {
  25     'identifier' => '4198123455512121'
  26     'seconds'    => '7200',
  27   };
  28
  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 =head1 DESCRIPTION
  39
  40 An FS::prepay_credit object represents a pre-paid card.  FS::prepay_credit
  41 inherits from FS::Record.  The following
  42 fields are currently supported:
  43
  44 =over 4
  45
  46 =item field - description
  47
  48 =item identifier - identifier entered by the user to receive the credit
  49
  50 =item amount - amount of the credit
  51
  52 =item seconds - time amount of credit (see L<FS::svc_acct/seconds>)
  53
  54 =item agentnum - optional agent (see L<FS::agent>) for this prepaid card
  55
  56 =back
  57
  58 =head1 METHODS
  59
  60 =over 4
  61
  62 =item new HASHREF
  63
  64 Creates a new pre-paid credit.  To add the example to the database, see
  65 L<"insert">.
  66
  67 Note that this stores the hash reference, not a distinct copy of the hash it
  68 points to.  You can ask the object for a copy with the I<hash> method.
  69
  70 =cut
  71
  72 sub table { 'prepay_credit'; }
  73
  74 =item insert
  75
  76 Adds this record to the database.  If there is an error, returns the error,
  77 otherwise returns false.
  78
  79 =cut
  80
  81 =item delete
  82
  83 Delete this record from the database.
  84
  85 =cut
  86
  87 =item replace OLD_RECORD
  88
  89 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  90 returns the error, otherwise returns false.
  91
  92 =cut
  93
  94 =item check
  95
  96 Checks all fields to make sure this is a valid pre-paid credit.  If there is
  97 an error, returns the error, otherwise returns false.  Called by the insert
  98 and replace methods.
  99
 100 =cut
 101
 102 sub check {
 103   my $self = shift;
 104
 105   my $identifier = $self->identifier;
 106   $identifier =~ s/\W//g; #anything else would just confuse things
 107   $self->identifier($identifier);
 108
 109   $self->ut_numbern('prepaynum')
 110   || $self->ut_alpha('identifier')
 111   || $self->ut_money('amount')
 112   || $self->ut_numbern('seconds')
 113   || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
 114   || $self->SUPER::check
 115   ;
 116
 117 }
 118
 119 =item agent
 120
 121 Returns the agent (see L<FS::agent>) for this prepaid card, if any.
 122
 123 =cut
 124
 125 sub agent {
 126   my $self = shift;
 127   qsearchs('agent', { 'agentnum' => $self->agentnum } );
 128 }
 129
 130 =back
 131
 132 =head1 SUBROUTINES
 133
 134 =over 4
 135
 136 =item generate NUM TYPE HASHREF
 137
 138 Generates the specified number of prepaid cards.  Returns an array reference of
 139 the newly generated card identifiers, or a scalar error message.
 140
 141 =cut
 142
 143 #false laziness w/agent::generate_reg_codes
 144 sub generate {
 145   my( $num, $type, $hashref ) = @_;
 146
 147   my @codeset = ();
 148   push @codeset, ( 'A'..'Z' ) if $type =~ /alpha/;
 149   push @codeset, ( '1'..'9' ) if $type =~ /numeric/;
 150
 151   local $SIG{HUP} = 'IGNORE';
 152   local $SIG{INT} = 'IGNORE';
 153   local $SIG{QUIT} = 'IGNORE';
 154   local $SIG{TERM} = 'IGNORE';
 155   local $SIG{TSTP} = 'IGNORE';
 156   local $SIG{PIPE} = 'IGNORE';
 157
 158   my $oldAutoCommit = $FS::UID::AutoCommit;
 159   local $FS::UID::AutoCommit = 0;
 160   my $dbh = dbh;
 161
 162   my @cards = ();
 163   for ( 1 ... $num ) {
 164     my $prepay_credit = new FS::prepay_credit {
 165       'identifier' => join('', map($codeset[int(rand $#codeset)], (0..7) ) ),
 166       %$hashref,
 167     };
 168     my $error = $prepay_credit->check || $prepay_credit->insert;
 169     if ( $error ) {
 170       $dbh->rollback if $oldAutoCommit;
 171       return "(inserting prepay_credit) $error";
 172     }
 173     push @cards, $prepay_credit->identifier;
 174   }
 175
 176   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 177
 178   \@cards;
 179
 180 }
 181
 182 =head1 BUGS
 183
 184 =head1 SEE ALSO
 185
 186 L<FS::svc_acct>, L<FS::Record>, schema.html from the base documentation.
 187
 188 =cut
 189
 190 1;
 191