Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/payment gateway option"

Latest revision as of 16:26, 3 October 2007

NAME

FS::payment_gateway_option - Object methods for payment_gateway_option records

SYNOPSIS

 use FS::payment_gateway_option;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::payment_gateway_option object represents an option key and value for a payment gateway. FS::payment_gateway_option inherits from FS::Record. The following fields are currently supported:

optionnum - primary key; gatewaynum -; optionname -; optionvalue -

METHODS

new HASHREF

Creates a new option. To add the option 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

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 option. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

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