|
|
| Line 1: |
Line 1: |
| − | ==NAME==
| |
| − | FS::banned_pay - Object methods for banned_pay records
| |
| | | | |
| − | ==SYNOPSIS==
| |
| − | <code>
| |
| − | use FS::banned_pay;
| |
| − |
| |
| − | $record = new FS::banned_pay \%hash;
| |
| − | $record = new FS::banned_pay { 'column' => 'value' };
| |
| − |
| |
| − | $error = $record->insert;
| |
| − |
| |
| − | $error = $new_record->replace($old_record);
| |
| − |
| |
| − | $error = $record->delete;
| |
| − |
| |
| − | $error = $record->check;
| |
| − | </code>
| |
| − | ==DESCRIPTION==
| |
| − | An FS::banned_pay object represents an banned credit card or ACH account. FS::banned_pay inherits from FS::Record. The following fields are currently supported:
| |
| − |
| |
| − | ; bannum - primary key; payby - ''CARD'' or ''CHEK''; payinfo - fingerprint of banned card (base64-encoded MD5 digest); _date - specified as a UNIX timestamp; see [[perlfunc#time|"time" in perlfunc]]. Also see [[Freeside:3:Documentation:Developer/Time/Local|Time::Local]] and [[Freeside:3:Documentation:Developer/Date/Parse|Date::Parse]] for conversion functions.; end_date - optional end date, also specified as a UNIX timestamp.; usernum - order taker (assigned automatically, see [[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]]); bantype - Ban type: "" or null (regular ban), "warn" (warning); reason - reason (text)
| |
| − | ==METHODS==
| |
| − | ; new HASHREF
| |
| − | :Creates a new ban. To add the ban to the database, see [[#insert|"insert"]].
| |
| − |
| |
| − | :Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the ''hash'' method.
| |
| − | ; insert
| |
| − | :Adds this record to the database. If there is an error, returns the error, otherwise returns false.
| |
| − | ; delete
| |
| − | :Delete this record from the database.
| |
| − | ; replace OLD_RECORD
| |
| − | :Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
| |
| − | ; check
| |
| − | :Checks all fields to make sure this is a valid ban. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
| |
| − |
| |
| − | ==CLASS METHODS==
| |
| − | ; ban_search OPTION => VALUE ...
| |
| − | :Takes two parameters: payby and payinfo, and searches for an (un-expired) ban matching those items.
| |
| − |
| |
| − | :Returns the ban, or false if no ban was found.
| |
| − |
| |
| − | ==BUGS==
| |
| − | ==SEE ALSO==
| |
| − | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.
| |
| − |
| |
| − | ==POD ERRORS==
| |
| − | Hey! '''The above document had some coding errors, which are explained below:'''
| |
| − |
| |
| − | ; Around line 135:
| |
| − | :'=item' outside of any '=over'
| |
