diff options
Diffstat (limited to 'httemplate/docs/man/FS/prepay_credit.html')
| -rw-r--r-- | httemplate/docs/man/FS/prepay_credit.html | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/httemplate/docs/man/FS/prepay_credit.html b/httemplate/docs/man/FS/prepay_credit.html new file mode 100644 index 000000000..4e77897a3 --- /dev/null +++ b/httemplate/docs/man/FS/prepay_credit.html @@ -0,0 +1,118 @@ +<HTML> +<HEAD> +<TITLE>FS::prepay_credit - Object methods for prepay_credit records</TITLE> +<LINK REV="made" HREF="mailto:perl@packages.debian.org"> +</HEAD> + +<BODY> + +<A NAME="__index__"></A> +<!-- INDEX BEGIN --> + +<UL> + + <LI><A HREF="#name">NAME</A></LI> + <LI><A HREF="#synopsis">SYNOPSIS</A></LI> + <LI><A HREF="#description">DESCRIPTION</A></LI> + <LI><A HREF="#methods">METHODS</A></LI> + <LI><A HREF="#version">VERSION</A></LI> + <LI><A HREF="#bugs">BUGS</A></LI> + <LI><A HREF="#see also">SEE ALSO</A></LI> + <LI><A HREF="#history">HISTORY</A></LI> +</UL> +<!-- INDEX END --> + +<HR> +<P> +<H1><A NAME="name">NAME</A></H1> +<P>FS::prepay_credit - Object methods for prepay_credit records</P> +<P> +<HR> +<H1><A NAME="synopsis">SYNOPSIS</A></H1> +<PRE> + use FS::prepay_credit;</PRE> +<PRE> + $record = new FS::prepay_credit \%hash; + $record = new FS::prepay_credit { + 'identifier' => '4198123455512121' + 'amount' => '19.95', + };</PRE> +<PRE> + $error = $record->insert;</PRE> +<PRE> + $error = $new_record->replace($old_record);</PRE> +<PRE> + $error = $record->delete;</PRE> +<PRE> + $error = $record->check;</PRE> +<P> +<HR> +<H1><A NAME="description">DESCRIPTION</A></H1> +<P>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:</P> +<DL> +<DT><STRONG><A NAME="item_field_%2D_description">field - description</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_identifier_%2D_identifier_entered_by_the_user_to_r">identifier - identifier entered by the user to receive the credit</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_amount_%2D_amount_of_the_credit">amount - amount of the credit</A></STRONG><BR> +<DD> +</DL> +<P> +<HR> +<H1><A NAME="methods">METHODS</A></H1> +<DL> +<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR> +<DD> +Creates a new pre-paid credit. To add the example to the database, see +<A HREF="#insert">insert</A>. +<P>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 <EM>hash</EM> method.</P> +<P></P> +<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> +<DD> +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. +<P></P> +<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR> +<DD> +Delete this record from the database. +<P></P> +<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR> +<DD> +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. +<P></P> +<DT><STRONG><A NAME="item_check">check</A></STRONG><BR> +<DD> +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. +<P></P></DL> +<P> +<HR> +<H1><A NAME="version">VERSION</A></H1> +<P>$Id: prepay_credit.html,v 1.1 2001-07-30 07:36:03 ivan Exp $</P> +<P> +<HR> +<H1><A NAME="bugs">BUGS</A></H1> +<P> +<HR> +<H1><A NAME="see also">SEE ALSO</A></H1> +<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, schema.html from the base documentation.</P> +<P> +<HR> +<H1><A NAME="history">HISTORY</A></H1> +<P>$Log: prepay_credit.html,v $ +<P>Revision 1.1 2001-07-30 07:36:03 ivan +<P>templates!!! +<P> +Revision 1.2 2000/02/02 20:22:18 ivan +bugfix prepayment in signup server</P> +<P>Revision 1.1 2000/01/31 05:22:23 ivan +prepaid ``internet cards''</P> + +</BODY> + +</HTML> |