FS/FS/banned_pay.pm

   1 package FS::banned_pay;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::UID qw( getotaker );
   7
   8 @ISA = qw(FS::Record);
   9
  10 =head1 NAME
  11
  12 FS::banned_pay - Object methods for banned_pay records
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::banned_pay;
  17
  18   $record = new FS::banned_pay \%hash;
  19   $record = new FS::banned_pay { 'column' => 'value' };
  20
  21   $error = $record->insert;
  22
  23   $error = $new_record->replace($old_record);
  24
  25   $error = $record->delete;
  26
  27   $error = $record->check;
  28
  29 =head1 DESCRIPTION
  30
  31 An FS::banned_pay object represents an banned credit card or ACH account.
  32 FS::banned_pay inherits from FS::Record.  The following fields are currently
  33 supported:
  34
  35 =over 4
  36
  37 =item bannum - primary key
  38
  39 =item payby - I<CARD> or I<CHEK>
  40
  41 =item payinfo - fingerprint of banned card (base64-encoded MD5 digest)
  42
  43 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  44 L<Time::Local> and L<Date::Parse> for conversion functions.
  45
  46 =item otaker - order taker (assigned automatically, see L<FS::UID>)
  47
  48 =item reason - reason (text)
  49
  50 =back
  51
  52 =head1 METHODS
  53
  54 =over 4
  55
  56 =item new HASHREF
  57
  58 Creates a new ban.  To add the ban to the database, see L<"insert">.
  59
  60 Note that this stores the hash reference, not a distinct copy of the hash it
  61 points to.  You can ask the object for a copy with the I<hash> method.
  62
  63 =cut
  64
  65 # the new method can be inherited from FS::Record, if a table method is defined
  66
  67 sub table { 'banned_pay'; }
  68
  69 =item insert
  70
  71 Adds this record to the database.  If there is an error, returns the error,
  72 otherwise returns false.
  73
  74 =cut
  75
  76 # the insert method can be inherited from FS::Record
  77
  78 =item delete
  79
  80 Delete this record from the database.
  81
  82 =cut
  83
  84 # the delete method can be inherited from FS::Record
  85
  86 =item replace OLD_RECORD
  87
  88 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  89 returns the error, otherwise returns false.
  90
  91 =cut
  92
  93 # the replace method can be inherited from FS::Record
  94
  95 =item check
  96
  97 Checks all fields to make sure this is a valid ban.  If there is
  98 an error, returns the error, otherwise returns false.  Called by the insert
  99 and replace methods.
 100
 101 =cut
 102
 103 # the check method should currently be supplied - FS::Record contains some
 104 # data checking routines
 105
 106 sub check {
 107   my $self = shift;
 108
 109   my $error =
 110     $self->ut_numbern('bannum')
 111     || $self->ut_enum('payby', [ 'CARD', 'CHEK' ] )
 112     || $self->ut_text('payinfo')
 113     || $self->ut_numbern('_date')
 114     || $self->ut_textn('reason')
 115   ;
 116   return $error if $error;
 117
 118   $self->_date(time) unless $self->_date;
 119
 120   $self->otaker(getotaker);
 121
 122   $self->SUPER::check;
 123 }
 124
 125 =back
 126
 127 =head1 BUGS
 128
 129 =head1 SEE ALSO
 130
 131 L<FS::Record>, schema.html from the base documentation.
 132
 133 =cut
 134
 135 1;
 136