Freeside:1.9:Documentation:Developer/FS/reg code pkg

From Freeside
< Freeside:1.9:Documentation:Developer‎ | FS
Revision as of 16:51, 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::reg_code_pkg - Class linking registration codes (see FS::reg_code) with package definitions (see FS::part_pkg)

SYNOPSIS

 use FS::reg_code_pkg;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::reg_code_pkg object links a registration code to a package definition. FS::table_name inherits from FS::Record. The following fields are currently supported:

codepkgnum - primary key; codenum - registration code (see FS::reg_code); pkgpart - package definition (see FS::part_pkg)

METHODS

new HASHREF
Creates a new registration code. To add the registration code 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.
part_pkg
Returns the package definition (see FS::part_pkg)

BUGS

Feeping creaturitis.

SEE ALSO

FS::reg_code_pkg, FS::Record, schema.html from the base documentation.