Freeside:1.9:Documentation:Developer/FS/pkg referral

From Freeside
< Freeside:1.9:Documentation:Developer‎ | FS
Revision as of 16:50, 3 October 2007 by Ivan (talk | contribs) (import from POD)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::pkg_referral - Object methods for pkg_referral records

SYNOPSIS

 use FS::pkg_referral;

 $record = new FS::pkg_referral \%hash;
 $record = new FS::pkg_referral { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::pkg_referral object represents the association of an advertising source with a specific customer package (purchase). FS::pkg_referral inherits from FS::Record. The following fields are currently supported:

pkgrefnum - primary key; pkgnum - Customer package. See FS::cust_pkg; refnum - Advertising source. See FS::part_referral

METHODS

new HASHREF
Creates a new record. To add the record to the database, see "insert"|#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 record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

Multiple pkg_referral records for a single package (configured off by default) still seems weird.

SEE ALSO

FS::part_referral, FS::cust_pkg, FS::Record, schema.html from the base documentation.