X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fprepay_credit.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fprepay_credit.html;h=0000000000000000000000000000000000000000;hb=1d758388ce3b17b8de1ae1d3a8ec39c1026baefc;hp=699b1c16fb350373a3eeb60e4a44422242b87376;hpb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc;p=freeside.git diff --git a/htdocs/docs/man/FS/prepay_credit.html b/htdocs/docs/man/FS/prepay_credit.html deleted file mode 100644 index 699b1c16f..000000000 --- a/htdocs/docs/man/FS/prepay_credit.html +++ /dev/null @@ -1,118 +0,0 @@ - - -FS::prepay_credit - Object methods for prepay_credit records - - - - - - - - -

- - -

NAME

FS::prepay_credit - Object methods for prepay_credit records

SYNOPSIS

-  use FS::prepay_credit;

-  $record = new FS::prepay_credit \%hash;
-  $record = new FS::prepay_credit {
-    'identifier' => '4198123455512121'
-    'amount'     => '19.95',
-  };

-  $error = $record->insert;

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

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::table_name object represents an pre--paid credit, such as a pre-paid -``calling card''. FS::prepay_credit inherits from FS::Record. The following -fields are currently supported:

field - description
-: -
identifier - identifier entered by the user to receive the credit
-: -
amount - amount of the credit
-: -

METHODS

new HASHREF
-

-Creates a new pre-paid credit. To add the example 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 pre-paid credit. If there is -an error, returns the error, otherwise returns false. Called by the insert -and replace methods. -

VERSION

$Id: prepay_credit.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

HISTORY

$Log: prepay_credit.html,v $ -

Revision 1.1 2001-04-23 12:41:57 ivan -

new API documentation -

-Revision 1.2 2000/02/02 20:22:18 ivan -bugfix prepayment in signup server

Revision 1.1 2000/01/31 05:22:23 ivan -prepaid ``internet cards''

- - - -