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 );
11 FS::banned_pay - Object methods for banned_pay records
17 $record = new FS::banned_pay \%hash;
18 $record = new FS::banned_pay { 'column' => 'value' };
20 $error = $record->insert;
22 $error = $new_record->replace($old_record);
24 $error = $record->delete;
26 $error = $record->check;
30 An FS::banned_pay object represents an banned credit card or ACH account.
31 FS::banned_pay inherits from FS::Record. The following fields are currently
36 =item bannum - primary key
38 =item payby - I<CARD> or I<CHEK>
40 =item payinfo - fingerprint of banned card (base64-encoded MD5 digest)
42 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
43 L<Time::Local> and L<Date::Parse> for conversion functions.
45 =item usernum - order taker (assigned automatically, see L<FS::access_user>)
47 =item reason - reason (text)
57 Creates a new ban. To add the ban to the database, see L<"insert">.
59 Note that this stores the hash reference, not a distinct copy of the hash it
60 points to. You can ask the object for a copy with the I<hash> method.
64 # the new method can be inherited from FS::Record, if a table method is defined
66 sub table { 'banned_pay'; }
70 Adds this record to the database. If there is an error, returns the error,
71 otherwise returns false.
75 # the insert method can be inherited from FS::Record
79 Delete this record from the database.
83 # the delete method can be inherited from FS::Record
85 =item replace OLD_RECORD
87 Replaces the OLD_RECORD with this one in the database. If there is an error,
88 returns the error, otherwise returns false.
92 # the replace method can be inherited from FS::Record
96 Checks all fields to make sure this is a valid ban. If there is
97 an error, returns the error, otherwise returns false. Called by the insert
102 # the check method should currently be supplied - FS::Record contains some
103 # data checking routines
109 $self->ut_numbern('bannum')
110 || $self->ut_enum('payby', [ 'CARD', 'CHEK' ] )
111 || $self->ut_text('payinfo')
112 || $self->ut_numbern('_date')
113 || $self->ut_textn('reason')
115 return $error if $error;
117 $self->_date(time) unless $self->_date;
119 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
124 # Used by FS::Upgrade to migrate to a new database.
125 sub _upgrade_data { # class method
126 my ($class, %opts) = @_;
127 $class->_upgrade_otaker(%opts);
136 L<FS::Record>, schema.html from the base documentation.