diff options
author | ivan <ivan> | 2005-08-17 22:23:46 +0000 |
---|---|---|
committer | ivan <ivan> | 2005-08-17 22:23:46 +0000 |
commit | feef0e4c2b4bd6b776b25f5a1bd6fdbf63fd08b2 (patch) | |
tree | ba578a825368c92a499f09c2278accf6da1509f8 /FS/FS/payment_gateway_option.pm | |
parent | 7af914081daa5896f1b0d69de0f48af6978f1fe4 (diff) |
infrastructure for easier schema changes, and: add payment_gateway, payment_gateway_option and agent_payment_gateway tables, add paystart_month, paystart_year, payissue and payip fields to cust_main, add preliminary gateway and gateway override editing to web UI, use payment gateway override when processing payments (card type, not taxclass yet)
Diffstat (limited to 'FS/FS/payment_gateway_option.pm')
-rw-r--r-- | FS/FS/payment_gateway_option.pm | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/FS/FS/payment_gateway_option.pm b/FS/FS/payment_gateway_option.pm new file mode 100644 index 0000000..0576022 --- /dev/null +++ b/FS/FS/payment_gateway_option.pm @@ -0,0 +1,126 @@ +package FS::payment_gateway_option; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( qsearch qsearchs ); + +@ISA = qw(FS::Record); + +=head1 NAME + +FS::payment_gateway_option - Object methods for payment_gateway_option records + +=head1 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; + +=head1 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: + +=over 4 + +=item optionnum - primary key + +=item gatewaynum - + +=item optionname - + +=item optionvalue - + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new option. To add the option to the database, see L<"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 I<hash> method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'payment_gateway_option'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +# the replace method can be inherited from FS::Record + +=item 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. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('optionnum') + || $self->ut_foreign_key('gatewaynum', 'payment_gateway', 'gatewaynum') + || $self->ut_text('optionname') + || $self->ut_textn('optionvalue') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |