FS/FS/payment_gateway_option.pm

   1 package FS::payment_gateway_option;
   2 use base qw(FS::Record);
   3
   4 use strict;
   5
   6 =head1 NAME
   7
   8 FS::payment_gateway_option - Object methods for payment_gateway_option records
   9
  10 =head1 SYNOPSIS
  11
  12   use FS::payment_gateway_option;
  13
  14   $record = new FS::payment_gateway_option \%hash;
  15   $record = new FS::payment_gateway_option { 'column' => 'value' };
  16
  17   $error = $record->insert;
  18
  19   $error = $new_record->replace($old_record);
  20
  21   $error = $record->delete;
  22
  23   $error = $record->check;
  24
  25 =head1 DESCRIPTION
  26
  27 An FS::payment_gateway_option object represents an option key and value for
  28 a payment gateway.  FS::payment_gateway_option inherits from
  29 FS::Record.  The following fields are currently supported:
  30
  31 =over 4
  32
  33 =item optionnum - primary key
  34
  35 =item gatewaynum -
  36
  37 =item optionname -
  38
  39 =item optionvalue -
  40
  41
  42 =back
  43
  44 =head1 METHODS
  45
  46 =over 4
  47
  48 =item new HASHREF
  49
  50 Creates a new option.  To add the option to the database, see L<"insert">.
  51
  52 Note that this stores the hash reference, not a distinct copy of the hash it
  53 points to.  You can ask the object for a copy with the I<hash> method.
  54
  55 =cut
  56
  57 # the new method can be inherited from FS::Record, if a table method is defined
  58
  59 sub table { 'payment_gateway_option'; }
  60
  61 =item insert
  62
  63 Adds this record to the database.  If there is an error, returns the error,
  64 otherwise returns false.
  65
  66 =cut
  67
  68 # the insert method can be inherited from FS::Record
  69
  70 =item delete
  71
  72 Delete this record from the database.
  73
  74 =cut
  75
  76 # the delete method can be inherited from FS::Record
  77
  78 =item replace OLD_RECORD
  79
  80 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  81 returns the error, otherwise returns false.
  82
  83 =cut
  84
  85 # the replace method can be inherited from FS::Record
  86
  87 =item check
  88
  89 Checks all fields to make sure this is a valid option.  If there is
  90 an error, returns the error, otherwise returns false.  Called by the insert
  91 and replace methods.
  92
  93 =cut
  94
  95 # the check method should currently be supplied - FS::Record contains some
  96 # data checking routines
  97
  98 sub check {
  99   my $self = shift;
 100
 101   my $error =
 102     $self->ut_numbern('optionnum')
 103     || $self->ut_foreign_key('gatewaynum', 'payment_gateway', 'gatewaynum')
 104     || $self->ut_text('optionname')
 105     || $self->ut_textn('optionvalue')
 106   ;
 107   return $error if $error;
 108
 109   $self->SUPER::check;
 110 }
 111
 112 =back
 113
 114 =head1 BUGS
 115
 116 =head1 SEE ALSO
 117
 118 L<FS::Record>, schema.html from the base documentation.
 119
 120 =cut
 121
 122 1;
 123