FS/FS/prepay_credit.pm

   1 package FS::prepay_credit;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 #use FS::Record qw( qsearch qsearchs );
   6 use FS::Record qw();
   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::table_name object represents an pre--paid credit, such as a pre-paid
  41 "calling card".  FS::prepay_credit 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 =back
  55
  56 =head1 METHODS
  57
  58 =over 4
  59
  60 =item new HASHREF
  61
  62 Creates a new pre-paid credit.  To add the example to the database, see
  63 L<"insert">.
  64
  65 Note that this stores the hash reference, not a distinct copy of the hash it
  66 points to.  You can ask the object for a copy with the I<hash> method.
  67
  68 =cut
  69
  70 sub table { 'prepay_credit'; }
  71
  72 =item insert
  73
  74 Adds this record to the database.  If there is an error, returns the error,
  75 otherwise returns false.
  76
  77 =cut
  78
  79 =item delete
  80
  81 Delete this record from the database.
  82
  83 =cut
  84
  85 =item replace OLD_RECORD
  86
  87 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  88 returns the error, otherwise returns false.
  89
  90 =cut
  91
  92 =item check
  93
  94 Checks all fields to make sure this is a valid pre-paid credit.  If there is
  95 an error, returns the error, otherwise returns false.  Called by the insert
  96 and replace methods.
  97
  98 =cut
  99
 100 sub check {
 101   my $self = shift;
 102
 103   my $identifier = $self->identifier;
 104   $identifier =~ s/\W//g; #anything else would just confuse things
 105   $self->identifier($identifier);
 106
 107   $self->ut_numbern('prepaynum')
 108   || $self->ut_alpha('identifier')
 109   || $self->ut_money('amount')
 110   || $self->utnumbern('seconds')
 111   || $self->SUPER::check
 112   ;
 113
 114 }
 115
 116 =back
 117
 118 =head1 BUGS
 119
 120 =head1 SEE ALSO
 121
 122 L<FS::svc_acct>, L<FS::Record>, schema.html from the base documentation.
 123
 124 =cut
 125
 126 1;
 127