|
|
Line 1: |
Line 1: |
− | ==NAME==
| |
− | FS::cdr_carrier - Object methods for cdr_carrier records
| |
| | | |
− | ==SYNOPSIS==
| |
− | <code>
| |
− | use FS::cdr_carrier;
| |
− |
| |
− | $record = new FS::cdr_carrier \%hash;
| |
− | $record = new FS::cdr_carrier { 'column' => 'value' };
| |
− |
| |
− | $error = $record->insert;
| |
− |
| |
− | $error = $new_record->replace($old_record);
| |
− |
| |
− | $error = $record->delete;
| |
− |
| |
− | $error = $record->check;
| |
− | </code>
| |
− | ==DESCRIPTION==
| |
− | An FS::cdr_carrier object represents an CDR carrier or upstream. FS::cdr_carrier inherits from FS::Record. The following fields are currently supported:
| |
− |
| |
− | ; carrierid - primary key; carriername - Carrier name
| |
− | ==METHODS==
| |
− | ; new HASHREF
| |
− | :Creates a new carrier. To add the carrier 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 carrier. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
| |
− |
| |
− | ==BUGS==
| |
− | ==SEE ALSO==
| |
− | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.
| |