Difference between revisions of "Freeside:3:Documentation:Developer/FS/reg code"

Latest revision as of 20:06, 27 June 2012

NAME

FS::reg_code - One-time registration codes

SYNOPSIS

 use FS::reg_code;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::reg_code object is a one-time registration code. FS::reg_code inherits from FS::Record. The following fields are currently supported:

codenum - primary key; code - registration code string; agentnum - Agent (see FS::agent)

METHODS

new HASHREF

Creates a new registration code. To add the code to the database, see "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 [ PKGPART_ARRAYREF ]

Adds this record to the database. If an arrayref of pkgparts (see FS::part_pkg) is specified, the appropriate reg_code_pkg records (see FS::reg_code_pkg) will be inserted.

If there is an error, returns the error, otherwise returns false.

delete

Delete this record (and all associated reg_code_pkg records) 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 registration code. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

part_pkg

Returns all package definitions (see FS::part_pkg for this registration code.

reg_code_pkg

Returns all FS::reg_code_pkg records for this registration code.

BUGS

Feeping creaturitis.

SEE ALSO

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