1 package FS::banned_pay;
4 use base qw( FS::otaker_Mixin FS::Record );
5 use FS::Record qw( qsearch qsearchs );
6 use FS::UID qw( getotaker );
10 FS::banned_pay - Object methods for banned_pay records
16 $record = new FS::banned_pay \%hash;
17 $record = new FS::banned_pay { 'column' => 'value' };
19 $error = $record->insert;
21 $error = $new_record->replace($old_record);
23 $error = $record->delete;
25 $error = $record->check;
29 An FS::banned_pay object represents an banned credit card or ACH account.
30 FS::banned_pay inherits from FS::Record. The following fields are currently
35 =item bannum - primary key
37 =item payby - I<CARD> or I<CHEK>
39 =item payinfo - fingerprint of banned card (base64-encoded MD5 digest)
41 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
42 L<Time::Local> and L<Date::Parse> for conversion functions.
44 =item otaker - order taker (assigned automatically, see L<FS::UID>)
46 =item reason - reason (text)
56 Creates a new ban. To add the ban to the database, see L<"insert">.
58 Note that this stores the hash reference, not a distinct copy of the hash it
59 points to. You can ask the object for a copy with the I<hash> method.
63 # the new method can be inherited from FS::Record, if a table method is defined
65 sub table { 'banned_pay'; }
69 Adds this record to the database. If there is an error, returns the error,
70 otherwise returns false.
74 # the insert method can be inherited from FS::Record
78 Delete this record from the database.
82 # the delete method can be inherited from FS::Record
84 =item replace OLD_RECORD
86 Replaces the OLD_RECORD with this one in the database. If there is an error,
87 returns the error, otherwise returns false.
91 # the replace method can be inherited from FS::Record
95 Checks all fields to make sure this is a valid ban. If there is
96 an error, returns the error, otherwise returns false. Called by the insert
101 # the check method should currently be supplied - FS::Record contains some
102 # data checking routines
108 $self->ut_numbern('bannum')
109 || $self->ut_enum('payby', [ 'CARD', 'CHEK' ] )
110 || $self->ut_text('payinfo')
111 || $self->ut_numbern('_date')
112 || $self->ut_textn('reason')
114 return $error if $error;
116 $self->_date(time) unless $self->_date;
118 $self->otaker(getotaker) unless $self->otaker;
123 # Used by FS::Upgrade to migrate to a new database.
124 sub _upgrade_data { # class method
125 my ($class, %opts) = @_;
126 $class->_upgrade_otaker(%opts);
135 L<FS::Record>, schema.html from the base documentation.