From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS/Bill.html | 32 +++ htdocs/docs/man/FS/CGI.html | 115 +++++++++ htdocs/docs/man/FS/Conf.html | 94 ++++++++ htdocs/docs/man/FS/Invoice.html | 32 +++ htdocs/docs/man/FS/Record.html | 380 ++++++++++++++++++++++++++++++ htdocs/docs/man/FS/SSH.html | 104 ++++++++ htdocs/docs/man/FS/UI/Base.html | 117 +++++++++ htdocs/docs/man/FS/UI/CGI.html | 115 +++++++++ htdocs/docs/man/FS/UI/Gtk.html | 112 +++++++++ htdocs/docs/man/FS/UI/agent.html | 0 htdocs/docs/man/FS/UID.html | 160 +++++++++++++ htdocs/docs/man/FS/agent.html | 130 ++++++++++ htdocs/docs/man/FS/agent_type.html | 138 +++++++++++ htdocs/docs/man/FS/cust_bill.html | 184 +++++++++++++++ htdocs/docs/man/FS/cust_bill_pkg.html | 119 ++++++++++ htdocs/docs/man/FS/cust_credit.html | 126 ++++++++++ htdocs/docs/man/FS/cust_main.html | 277 ++++++++++++++++++++++ htdocs/docs/man/FS/cust_main_county.html | 113 +++++++++ htdocs/docs/man/FS/cust_main_invoice.html | 128 ++++++++++ htdocs/docs/man/FS/cust_pay.html | 116 +++++++++ htdocs/docs/man/FS/cust_pay_batch.html | 134 +++++++++++ htdocs/docs/man/FS/cust_pkg.html | 254 ++++++++++++++++++++ htdocs/docs/man/FS/cust_refund.html | 116 +++++++++ htdocs/docs/man/FS/cust_svc.html | 134 +++++++++++ htdocs/docs/man/FS/dbdef.html | 97 ++++++++ htdocs/docs/man/FS/dbdef_colgroup.html | 86 +++++++ htdocs/docs/man/FS/dbdef_column.html | 118 ++++++++++ htdocs/docs/man/FS/dbdef_index.html | 58 +++++ htdocs/docs/man/FS/dbdef_table.html | 144 +++++++++++ htdocs/docs/man/FS/dbdef_unique.html | 58 +++++ htdocs/docs/man/FS/part_pkg.html | 152 ++++++++++++ htdocs/docs/man/FS/part_referral.html | 113 +++++++++ htdocs/docs/man/FS/part_svc.html | 121 ++++++++++ htdocs/docs/man/FS/pkg_svc.html | 125 ++++++++++ htdocs/docs/man/FS/svc_Common.html | 109 +++++++++ htdocs/docs/man/FS/svc_acct.html | 210 +++++++++++++++++ htdocs/docs/man/FS/svc_acct_pop.html | 115 +++++++++ htdocs/docs/man/FS/svc_acct_sm.html | 172 ++++++++++++++ htdocs/docs/man/FS/svc_domain.html | 196 +++++++++++++++ htdocs/docs/man/FS/type_pkgs.html | 109 +++++++++ 40 files changed, 5213 insertions(+) create mode 100644 htdocs/docs/man/FS/Bill.html create mode 100644 htdocs/docs/man/FS/CGI.html create mode 100644 htdocs/docs/man/FS/Conf.html create mode 100644 htdocs/docs/man/FS/Invoice.html create mode 100644 htdocs/docs/man/FS/Record.html create mode 100644 htdocs/docs/man/FS/SSH.html create mode 100644 htdocs/docs/man/FS/UI/Base.html create mode 100644 htdocs/docs/man/FS/UI/CGI.html create mode 100644 htdocs/docs/man/FS/UI/Gtk.html create mode 100644 htdocs/docs/man/FS/UI/agent.html create mode 100644 htdocs/docs/man/FS/UID.html create mode 100644 htdocs/docs/man/FS/agent.html create mode 100644 htdocs/docs/man/FS/agent_type.html create mode 100644 htdocs/docs/man/FS/cust_bill.html create mode 100644 htdocs/docs/man/FS/cust_bill_pkg.html create mode 100644 htdocs/docs/man/FS/cust_credit.html create mode 100644 htdocs/docs/man/FS/cust_main.html create mode 100644 htdocs/docs/man/FS/cust_main_county.html create mode 100644 htdocs/docs/man/FS/cust_main_invoice.html create mode 100644 htdocs/docs/man/FS/cust_pay.html create mode 100644 htdocs/docs/man/FS/cust_pay_batch.html create mode 100644 htdocs/docs/man/FS/cust_pkg.html create mode 100644 htdocs/docs/man/FS/cust_refund.html create mode 100644 htdocs/docs/man/FS/cust_svc.html create mode 100644 htdocs/docs/man/FS/dbdef.html create mode 100644 htdocs/docs/man/FS/dbdef_colgroup.html create mode 100644 htdocs/docs/man/FS/dbdef_column.html create mode 100644 htdocs/docs/man/FS/dbdef_index.html create mode 100644 htdocs/docs/man/FS/dbdef_table.html create mode 100644 htdocs/docs/man/FS/dbdef_unique.html create mode 100644 htdocs/docs/man/FS/part_pkg.html create mode 100644 htdocs/docs/man/FS/part_referral.html create mode 100644 htdocs/docs/man/FS/part_svc.html create mode 100644 htdocs/docs/man/FS/pkg_svc.html create mode 100644 htdocs/docs/man/FS/svc_Common.html create mode 100644 htdocs/docs/man/FS/svc_acct.html create mode 100644 htdocs/docs/man/FS/svc_acct_pop.html create mode 100644 htdocs/docs/man/FS/svc_acct_sm.html create mode 100644 htdocs/docs/man/FS/svc_domain.html create mode 100644 htdocs/docs/man/FS/type_pkgs.html (limited to 'htdocs/docs/man/FS') diff --git a/htdocs/docs/man/FS/Bill.html b/htdocs/docs/man/FS/Bill.html new file mode 100644 index 000000000..e5832f8d9 --- /dev/null +++ b/htdocs/docs/man/FS/Bill.html @@ -0,0 +1,32 @@ + + +FS::Bill - Legacy stub + + + + + + + +

+ + +

NAME

+FS::Bill - Legacy stub + +

SYNOPSIS

+The functionality of FS::Bill has been integrated into FS::cust_main. + + + + diff --git a/htdocs/docs/man/FS/CGI.html b/htdocs/docs/man/FS/CGI.html new file mode 100644 index 000000000..e1a42ec59 --- /dev/null +++ b/htdocs/docs/man/FS/CGI.html @@ -0,0 +1,115 @@ + + +FS::CGI - Subroutines for the web interface + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
SUBROUTINES +
BUGS +
SEE ALSO +

+ + +

NAME

+FS::CGI - Subroutines for the web interface + +

SYNOPSIS

  use FS::CGI qw(header menubar idiot eidiot popurl);
+

  print header( 'Title', '' );
+  print header( 'Title', menubar('item', 'URL', ... ) );
+

  idiot "error message"; 
+  eidiot "error message";
+

  $url = popurl; #returns current url
+  $url = popurl(3); #three levels up
+

DESCRIPTION

+Provides a few common subroutines for the web interface. + +

SUBROUTINES

header TITLE, MENUBAR

+Returns an HTML header. + +

menubar ITEM, URL, ...

+Returns an HTML menubar. + +

idiot ERROR

+This is depriciated. Don't use it. + +

+Sends headers and an HTML error message. + +

eidiot ERROR

+This is depriciated. Don't use it. + +

+Sends headers and an HTML error message, then exits. + +

popurl LEVEL

+Returns current URL with LEVEL levels of path removed from the end (default +0). + +

table

+Returns HTML tag for beginning a table. + +

itable

+Returns HTML tag for beginning an (invisible) table. + +

ntable

+This is getting silly. + +

BUGS

+Not OO. + +

+Not complete. + +

NAME

+FS::Conf - Read access to Freeside configuration values + +

SYNOPSIS

  use FS::Conf;
+

  $conf = new FS::Conf "/config/directory";
+

  $FS::Conf::default_dir = "/config/directory";
+  $conf = new FS::Conf;
+

  $dir = $conf->dir;
+

  $value = $conf->config('key');
+  @list  = $conf->config('key');
+  $bool  = $conf->exists('key');
+

DESCRIPTION

+Read access to Freeside configuration values. Keys currently map to +filenames, but this may change in the future. + +

METHODS

new [ DIRECTORY ]: +
+Create a new configuration object. A directory arguement is required if +$FS::Conf::default_dir has not been set. + +
dir: +
+Returns the directory. + +
config: +
+Returns the configuration value or values (depending on context) for key. + +
exists: +
+Returns true if the specified key exists, even if the corresponding value +is undefined. + +

BUGS

+Write access (with locking) should be implemented. + +

NAME

+FS::Invoice - Legacy stub + +

SYNOPSIS

+The functionality of FS::Invoice has been integrated in FS::cust_bill. + + + + diff --git a/htdocs/docs/man/FS/Record.html b/htdocs/docs/man/FS/Record.html new file mode 100644 index 000000000..da1fc5287 --- /dev/null +++ b/htdocs/docs/man/FS/Record.html @@ -0,0 +1,380 @@ + + +FS::Record - Database record objects + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
CONSTRUCTORS +
METHODS +
SUBROUTINES +
VERSION +
BUGS +
SEE ALSO +

+ + +

NAME

+FS::Record - Database record objects + +

SYNOPSIS

    use FS::Record;
+    use FS::Record qw(dbh fields qsearch qsearchs dbdef);
+

    $record = new FS::Record 'table', \%hash;
+    $record = new FS::Record 'table', { 'column' => 'value', ... };
+

    $record  = qsearchs FS::Record 'table', \%hash;
+    $record  = qsearchs FS::Record 'table', { 'column' => 'value', ... };
+    @records = qsearch  FS::Record 'table', \%hash; 
+    @records = qsearch  FS::Record 'table', { 'column' => 'value', ... };
+

    $table = $record->table;
+    $dbdef_table = $record->dbdef_table;
+

    $value = $record->get('column');
+    $value = $record->getfield('column');
+    $value = $record->column;
+

    $record->set( 'column' => 'value' );
+    $record->setfield( 'column' => 'value' );
+    $record->column('value');
+

    %hash = $record->hash;
+

    $hashref = $record->hashref;
+

    $error = $record->insert;
+    #$error = $record->add; #depriciated
+

    $error = $record->delete;
+    #$error = $record->del; #depriciated
+

    $error = $new_record->replace($old_record);
+    #$error = $new_record->rep($old_record); #depriciated
+

    $value = $record->unique('column');
+

    $value = $record->ut_float('column');
+    $value = $record->ut_number('column');
+    $value = $record->ut_numbern('column');
+    $value = $record->ut_money('column');
+    $value = $record->ut_text('column');
+    $value = $record->ut_textn('column');
+    $value = $record->ut_alpha('column');
+    $value = $record->ut_alphan('column');
+    $value = $record->ut_phonen('column');
+    $value = $record->ut_anythingn('column');
+

    $dbdef = reload_dbdef;
+    $dbdef = reload_dbdef "/non/standard/filename";
+    $dbdef = dbdef;
+

    $quoted_value = _quote($value,'table','field');
+

    #depriciated
+    $fields = hfields('table');
+    if ( $fields->{Field} ) { # etc.
+

    @fields = fields 'table'; #as a subroutine
+    @fields = $record->fields; #as a method call
+

DESCRIPTION

+(Mostly) object-oriented interface to database records. Records are +currently implemented on top of DBI. FS::Record is intended as a base class +for table-specific classes to inherit from, i.e. FS::cust_main. + +

CONSTRUCTORS

new [ TABLE, ] HASHREF

+Creates a new record. It doesn't store it in the database, though. See +insert for that. + +

+Note that the object stores this hash reference, not a distinct copy of the +hash it points to. You can ask the object for a copy with the hash +method. + +

+TABLE can only be omitted when a dervived class overrides the table method. + +

qsearch TABLE, HASHREF

+Searches the database for all records matching (at least) the key/value +pairs in HASHREF. Returns all the records found as `FS::TABLE' objects if +that module is loaded (i.e. via `use FS::cust_main;'), otherwise returns +FS::Record objects. + +

qsearchs TABLE, HASHREF

+Same as qsearch, except that if more than one record matches, it carps but returns the first. If this happens, you either made a logic error in +asking for a single item, or your data is corrupted. + +

METHODS

table

+Returns the table name. + +

dbdef_table

+Returns the FS::dbdef_table object for the table. + +

get, getfield COLUMN

+Returns the value of the column/field/key COLUMN. + +

set, setfield COLUMN, VALUE

+Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE. + +

AUTLOADED METHODS

+$record->column is a synonym for $record->get('column'); + +

+$record->column('value') is a synonym for +$record->set('column','value'); + +

hash

+Returns a list of the column/value pairs, usually for assigning to a new +hash. + +

+To make a distinct duplicate of an FS::Record object, you can do: + +

    $new = new FS::Record ( $old->table, { $old->hash } );
+

hashref

+Returns a reference to the column/value hash. + +

insert

+Inserts this record to the database. If there is an error, returns the +error, otherwise returns false. + +

add

+Depriciated (use insert instead). + +

delete

+Delete this record from the database. If there is an error, returns the +error, otherwise returns false. + +

del

+Depriciated (use delete instead). + +

replace OLD_RECORD

+Replace the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +

rep

+Depriciated (use replace instead). + +

check

+Not yet implemented, croaks. Derived classes should provide a check method. + +

unique COLUMN

+Replaces COLUMN in record with a unique number. Called by the add method on primary keys and single-field unique columns (see FS::dbdef_table). Returns the new value. + +

ut_float COLUMN

+Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be +null. If there is an error, returns the error, otherwise returns false. + +

ut_number COLUMN

+Check/untaint simple numeric data (whole numbers). May not be null. If +there is an error, returns the error, otherwise returns false. + +

ut_numbern COLUMN

+Check/untaint simple numeric data (whole numbers). May be null. If there is +an error, returns the error, otherwise returns false. + +

ut_money COLUMN

+Check/untaint monetary numbers. May be negative. Set to 0 if null. If there +is an error, returns the error, otherwise returns false. + +

ut_text COLUMN

+Check/untaint text. Alphanumerics, spaces, and the following punctuation +symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? / +May not be null. If there is an error, returns the error, otherwise returns +false. + +

ut_textn COLUMN

+Check/untaint text. Alphanumerics, spaces, and the following punctuation +symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? / +May be null. If there is an error, returns the error, otherwise returns +false. + +

ut_alpha COLUMN

+Check/untaint alphanumeric strings (no spaces). May not be null. If there +is an error, returns the error, otherwise returns false. + +

ut_alpha COLUMN

+Check/untaint alphanumeric strings (no spaces). May be null. If there is an +error, returns the error, otherwise returns false. + +

ut_phonen COLUMN

+Check/untaint phone numbers. May be null. If there is an error, returns the +error, otherwise returns false. + +

ut_anything COLUMN

+Untaints arbitrary data. Be careful. + +

fields [ TABLE ]

+This can be used as both a subroutine and a method call. It returns a list +of the columns in this record's table, or an explicitly specified table. +(See FS::dbdef_table). + +

SUBROUTINES

reload_dbdef([FILENAME])

+Load a database definition (see FS::dbdef), optionally from a non-default filename. This command is executed at +startup unless +$FS::Record::setup_hack is true. Returns a FS::dbdef object. + +

dbdef

+Returns the current database definition. See FS::dbdef. + +

_quote VALUE, TABLE, COLUMN

+This is an internal function used to construct SQL statements. It returns +VALUE DBI-quoted (see DBI) unless VALUE is a number and the column type (see FS::dbdef_column) does not end in `char' or `binary'. + +

hfields TABLE

+This is depriciated. Don't use it. + +

+It returns a hash-type list with the fields of this record's table set +true. + +

VERSION

+$Id: Record.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This module should probably be renamed, since much of the functionality is +of general use. It is not completely unlike Adapter::DBI (see below). + +

+Exported qsearch and qsearchs should be depriciated in favor of method +calls (against an FS::Record object like the old search and searchs that +qsearch and qsearchs were on top of.) + +

+The whole fields / hfields mess should be removed. + +

+The various WHERE clauses should be subroutined. + +

+table string should be depriciated in favor of FS::dbdef_table. + +

+No doubt we could benefit from a Tied hash. Documenting how exists / +defined true maps to the database (and WHERE clauses) would also help. + +

+The ut_ methods should ask the dbdef for a default length. + +

+ut_sqltype (like ut_varchar) should all be defined + +

+A fallback check method should be provided whith uses the dbdef. + +

+The ut_money method assumes money has two decimal digits. + +

+The Pg money kludge in the new method only strips `$'. + +

+The ut_phonen method assumes US-style phone numbers. + +

+The _quote function should probably use ut_float instead of a regex. + +

+All the subroutines probably should be methods, here or elsewhere. + +

+Probably should borrow/use some dbdef methods where appropriate (like sub +fields) + +

NAME

+FS::SSH - Subroutines to call ssh and scp + +

SYNOPSIS

  use FS::SSH qw(ssh scp issh iscp sshopen2 sshopen3);
+

  ssh($host, $command);
+

  issh($host, $command);
+

  scp($source, $destination);
+

  iscp($source, $destination);
+

  sshopen2($host, $reader, $writer, $command);
+

  sshopen3($host, $reader, $writer, $error, $command);
+

DESCRIPTION

  Simple wrappers around ssh and scp commands.
+

SUBROUTINES

ssh HOST, COMMAND

+Calls ssh in batch mode. + +

issh HOST, COMMAND

+Prints the ssh command to be executed, waits for the user to confirm, and +(optionally) executes the command. + +

scp SOURCE, DESTINATION

+Calls scp in batch mode. + +

iscp SOURCE, DESTINATION

+Prints the scp command to be executed, waits for the user to confirm, and +(optionally) executes the command. + +

sshopen2 HOST, READER, WRITER, COMMAND

+Connects the supplied filehandles to the ssh process (in batch mode). + +

sshopen3 HOST, WRITER, READER, ERROR, COMMAND

+Connects the supplied filehandles to the ssh process (in batch mode). + +

BUGS

+Not OO. + +

+scp stuff should transparantly use rsync-over-ssh instead. + +

NAME

+FS::UI::Base - Base class for all user-interface objects + +

SYNOPSIS

  use FS::UI::SomeInterface;
+  use FS::UI::some_table;
+

  $interface = new FS::UI::some_table;
+

  $error = $interface->browse;
+  $error = $interface->search;
+  $error = $interface->view;
+  $error = $interface->edit;
+  $error = $interface->process;
+

DESCRIPTION

+An FS::UI::Base object represents a user interface object. FS::UI::Base is +intended as a base class for table-specfic classes to inherit from, i.e. +FS::UI::cust_main. The simplest case, which will provide a default UI for +your new table, is as follows: + +

  package FS::UI::table_name;
+  use vars qw ( @ISA );
+  use FS::UI::Base;
+  @ISA = qw( FS::UI::Base );
+  sub db_table { 'table_name'; }
+

+Currently available interfaces are: FS::UI::Gtk, an X-Windows UI +implemented using the Gtk+ toolkit FS::UI::CGI, a web interface implemented +using CGI.pm, etc. + +

METHODS

new: +
browse: +
title: +
addwidget: +

VERSION

+$Id: Base.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This documentation is incomplete. + +

+There should be some sort of per-(freeside)-user preferences and the +ability for specific FS::UI:: modules to put their own values there as +well. + +

HISTORY

+$Log: Base.html,v $ +Revision 1.1 1999-08-04 12:13:27 ivan +new HTML manpages + Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of +module files for proper perl installation + +

+Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. + + + + diff --git a/htdocs/docs/man/FS/UI/CGI.html b/htdocs/docs/man/FS/UI/CGI.html new file mode 100644 index 000000000..c3efdc746 --- /dev/null +++ b/htdocs/docs/man/FS/UI/CGI.html @@ -0,0 +1,115 @@ + + +FS::UI::CGI - Base class for CGI user-interface objects + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
METHODS +
VERSION +
BUGS +
SEE ALSO +
HISTORY +

+ + +

NAME

+FS::UI::CGI - Base class for CGI user-interface objects + +

SYNOPSIS

  use FS::UI::CGI;
+  use FS::UI::some_table;
+

  $interface = new FS::UI::some_table;
+

  $error = $interface->browse;
+  $error = $interface->search;
+  $error = $interface->view;
+  $error = $interface->edit;
+  $error = $interface->process;
+

DESCRIPTION

+An FS::UI::CGI object represents a CGI interface object. + +

METHODS

new: +
_header: +
_footer: +
interface: +
+Returns the string `CGI'. Useful for the author of a table-specific UI +class to conditionally specify certain behaviour. + +

VERSION

+$Id: CGI.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This documentation is incomplete. + +

+In _Tableborder, headers should be links that sort on their fields. + +

+_Link uses a constant $BASE_URL + +

+_Link passes the arguments as a manually-constructed GET string instead of +POSTing, for compatability while the web interface is upgraded. Once this +is done it should pass arguements properly (i.e. as a POST, 8-bit clean) + +

+Still some small bits of widget code same as FS::UI::Gtk. + +

HISTORY

+$Log: CGI.html,v $ +Revision 1.1 1999-08-04 12:13:27 ivan +new HTML manpages + Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of +module files for proper perl installation + +

+Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. + + + + diff --git a/htdocs/docs/man/FS/UI/Gtk.html b/htdocs/docs/man/FS/UI/Gtk.html new file mode 100644 index 000000000..cb2a864ac --- /dev/null +++ b/htdocs/docs/man/FS/UI/Gtk.html @@ -0,0 +1,112 @@ + + +FS::UI::Gtk - Base class for Gtk user-interface objects + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
METHODS +
VERSION +
BUGS +
SEE ALSO +
HISTORY +

+ + +

NAME

+FS::UI::Gtk - Base class for Gtk user-interface objects + +

SYNOPSIS

  use FS::UI::Gtk;
+  use FS::UI::some_table;
+

  $interface = new FS::UI::some_table;
+

  $error = $interface->browse;
+  $error = $interface->search;
+  $error = $interface->view;
+  $error = $interface->edit;
+  $error = $interface->process;
+

DESCRIPTION

+An FS::UI::Gtk object represents a Gtk user interface object. + +

METHODS

new: +
interface: +
+Returns the string `Gtk'. Useful for the author of a table-specific UI +class to conditionally specify certain behaviour. + +

VERSION

+$Id: Gtk.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This documentation is incomplete. + +

+_Tableborder is just a _Table now. _Tableborders should scroll (but not the +headers) and need and need more decoration. (data in white section ala +gtksql and sliding field widths) headers should be buttons that callback to +sort on their fields. + +

+There should be a persistant, per-(freeside)-user store for window +positions and sizes and sort fields etc (see BUGS. + +

+Still some small bits of widget code same as FS::UI::CGI. + +

HISTORY

+$Log: Gtk.html,v $ +Revision 1.1 1999-08-04 12:13:27 ivan +new HTML manpages + Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of +module files for proper perl installation + +

+Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. + + + + diff --git a/htdocs/docs/man/FS/UI/agent.html b/htdocs/docs/man/FS/UI/agent.html new file mode 100644 index 000000000..e69de29bb diff --git a/htdocs/docs/man/FS/UID.html b/htdocs/docs/man/FS/UID.html new file mode 100644 index 000000000..34444623a --- /dev/null +++ b/htdocs/docs/man/FS/UID.html @@ -0,0 +1,160 @@ + + +FS::UID - Subroutines for database login and assorted other stuff + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
SUBROUTINES +
CALLBACKS +
VERSION +
BUGS +
SEE ALSO +

+ + +

NAME

+FS::UID - Subroutines for database login and assorted other stuff + +

SYNOPSIS

  use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker
+  checkeuid checkruid swapuid);
+

  adminsuidsetup $user;
+

  $cgi = new CGI;
+  $dbh = cgisuidsetup($cgi);
+

  $dbh = dbh;
+

  $datasrc = datasrc;
+

DESCRIPTION

+Provides a hodgepodge of subroutines. + +

SUBROUTINES

adminsuidsetup USER: +
+Sets the user to USER (see config.html from the base documentation). Cleans +the environment. Make sure the script is running as freeside, or setuid +freeside. Opens a connection to the database. Swaps real and effective +UIDs. Runs any defined callbacks (see below). Returns the DBI database +handle (usually you don't need this). + +
cgisuidsetup CGI_object: +
+Stores the CGI (see the CGI manpage) object for later use. (CGI::Base is depriciated) Runs adminsuidsetup. + +
cgi: +
+Returns the CGI (see the CGI manpage) object. + +
dbh: +
+Returns the DBI database handle. + +
datasrc: +
+Returns the DBI data source. + +
getotaker: +
+Returns the current Freeside user. + +
cgisetotaker: +
+Sets and returns the CGI REMOTE_USER. $cgi should +be defined as a CGI.pm object. Support for CGI::Base and derived classes is +depriciated. + +
checkeuid: +
+Returns true if effective UID is that of the freeside user. + +
checkruid: +
+Returns true if the real UID is that of the freeside user. + +
swapuid: +
+Swaps real and effective UIDs. + +
getsecrets [ USER ]: +
+Sets the user to USER, if supplied. Sets and returns the DBI datasource, +username and password for this user from the +`/usr/local/etc/freeside/mapsecrets' file. + +

CALLBACKS

+Warning: this interface is likely to change in future releases. + +

+A package can install a callback to be run in adminsuidsetup by putting a +coderef into the hash %FS::UID::callback : + +

    $coderef = sub { warn "Hi, I'm returning your call!" };
+    $FS::UID::callback{'Package::Name'};
+

VERSION

+$Id: UID.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+Too many package-global variables. + +

+Not OO. + +

+No capabilities yet. When mod_perl and Authen::DBI are implemented, +cgisuidsetup will go away as well. + +

+Goes through contortions to support non-OO syntax with multiple datasrc's. + +

+Callbacks are inelegant. + +

NAME

+FS::agent - Object methods for agent records + +

SYNOPSIS

  use FS::agent;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $agent_type = $record->agent_type;
+

  $hashref = $record->pkgpart_hashref;
+  #may purchase $pkgpart if $hashref->{$pkgpart};
+

DESCRIPTION

+An FS::agent object represents an agent. Every customer has an agent. +Agents can be used to track things like resellers or salespeople. FS::agent +inherits from FS::Record. The following fields are currently supported: + +

agemtnum - primary key (assigned automatically for new agents): +
agent - Text name of this agent: +
typenum - Agent type. See FS::agent_type: +
prog - For future use.: +
freq - For future use.: +

METHODS

new HASHREF: +
+Creates a new agent. To add the agent to the database, see insert. + +
insert: +
+Adds this agent to the database. If there is an error, returns the error, +otherwise returns false. + +
delete: +
+Deletes this agent from the database. Only agents with no customers can be +deleted. If there is an error, returns the error, otherwise returns false. + +
replace OLD_RECORD: +
+Replaces 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 agent. If there is an error, +returns the error, otherwise returns false. Called by the insert and +replace methods. + +
agent_type: +
+Returns the FS::agent_type object (see FS::agent_type) for this agent. + +
pkgpart_hashref: +
+Returns a hash reference. The keys of the hash are pkgparts. The value is +true iff this agent may purchase the specified package definition. See +FS::part_pkg. + +

VERSION

+$Id: agent.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

NAME

+FS::agent_type - Object methods for agent_type records + +

SYNOPSIS

  use FS::agent_type;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $hashref = $record->pkgpart_hashref;
+  #may purchase $pkgpart if $hashref->{$pkgpart};
+

  @type_pkgs = $record->type_pkgs;
+

  @pkgparts = $record->pkgpart;
+

DESCRIPTION

+An FS::agent_type object represents an agent type. Every agent (see +FS::agent) has an agent type. Agent types define which packages (see +FS::part_pkg) may be purchased by customers (see FS::cust_main), via FS::type_pkgs records (see FS::type_pkgs). FS::agent_type inherits from FS::Record. The following fields are +currently supported: + +

typenum - primary key (assigned automatically for new agent types): +
atype - Text name of this agent type: +

METHODS

new HASHREF: +
+Creates a new agent type. To add the agent type to the database, see +insert. + +
insert: +
+Adds this agent type to the database. If there is an error, returns the +error, otherwise returns false. + +
delete: +
+Deletes this agent type from the database. Only agent types with no agents +can be deleted. If there is an error, returns the error, otherwise returns +false. + +
replace OLD_RECORD: +
+Replaces 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 agent type. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +
pkgpart_hashref: +
+Returns a hash reference. The keys of the hash are pkgparts. The value is +true iff this agent may purchase the specified package definition. See +FS::part_pkg. + +
type_pkgs: +
+Returns all FS::type_pkgs objects (see FS::type_pkgs) for this agent type. + +
pkgpart: +
+Returns the pkgpart of all package definitions (see FS::part_pkg) for this agent type. + +

VERSION

+$Id: agent_type.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

NAME

+FS::cust_bill - Object methods for cust_bill records + +

SYNOPSIS

  use FS::cust_bill;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
+

  @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
+

  ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
+

  @cust_pay_objects = $cust_bill->cust_pay;
+

  @lines = $cust_bill->print_text;
+  @lines = $cust_bill->print_text $time;
+

DESCRIPTION

+An FS::cust_bill object represents an invoice. FS::cust_bill inherits from +FS::Record. The following fields are currently supported: + +

invnum - primary key (assigned automatically for new invoices): +
custnum - customer (see FS::cust_main): +
_date - specified as a UNIX timestamp; see perlfunc/"time". Also see +Time::Local and Date::Parse for conversion functions.: +
charged - amount of this invoice: +
owed - amount still outstanding on this invoice, which is charged minus +all payments (see FS::cust_pay).: +
printed - how many times this invoice has been printed automatically +(see FS::cust_main/"collect").: +

METHODS

new HASHREF

+Creates a new invoice. To add the invoice to the database, see insert. Invoices are normally created by calling the bill method of a customer +object (see FS::cust_main). + +

insert

+Adds this invoice to the database (``Posts'' the invoice). If there is an +error, returns the error, otherwise returns false. + +

+When adding new invoices, owed must be charged (or null, in which case it +is automatically set to charged). + +

delete

+Currently unimplemented. I don't remove invoices because there would then +be no record you ever posted this invoice (which is bad, no?) + +

replace OLD_RECORD

+Replaces the OLD_RECORD with this one in the database. If there is an +error, returns the error, otherwise returns false. + +

+Only owed and printed may be changed. Owed is normally updated by creating +and inserting a payment (see FS::cust_pay). Printed is normally updated by calling the collect method of a customer +object (see FS::cust_main). + +

check

+Checks all fields to make sure this is a valid invoice. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

previous

+Returns a list consisting of the total previous balance for this customer, +followed by the previous outstanding invoices (as FS::cust_bill objects +also). + +

cust_bill_pkg

+Returns the line items (see FS::cust_bill_pkg) for this invoice. + +

cust_credit

+Returns a list consisting of the total previous credited (see +FS::cust_credit) for this customer, followed by the previous outstanding credits +(FS::cust_credit objects). + +

cust_pay

+Returns all payments (see FS::cust_pay) for this invoice. + +

print_text [TIME];

+Returns an ASCII invoice, as a list of lines. + +

+TIME an optional value used to control the printing of overdue messages. +The default is now. It isn't the date of the invoice; that's the `_date' +field. It is specified as a UNIX timestamp; see perlfunc. Also see +Time::Local and Date::Parse for conversion functions. + +

VERSION

+$Id: cust_bill.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The delete method. + +

+print_text formatting (and some logic :/) is in source, but needs to be +slurped in from a file. Also number of lines ($=). + +

+missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style +or something similar so the look can be completely customized?) + +

NAME

+FS::cust_bill_pkg - Object methods for cust_bill_pkg records + +

SYNOPSIS

  use FS::cust_bill_pkg;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::cust_bill_pkg object represents an invoice line item. +FS::cust_bill_pkg inherits from FS::Record. The following fields are +currently supported: + +

invnum - invoice (see FS::cust_bill): +
pkgnum - package (see FS::cust_pkg): +
setup - setup fee: +
recur - recurring fee: +
sdate - starting date of recurring fee: +
edate - ending date of recurring fee: +

+sdate and edate are specified as UNIX timestamps; see perlfunc. Also see Time::Local and Date::Parse for conversion functions. + +

METHODS

new HASHREF: +
+Creates a new line item. To add the line item to the database, see +insert. Line items are normally created by calling the bill method of a customer +object (see FS::cust_main). + +
insert: +
+Adds this line item to the database. If there is an error, returns the +error, otherwise returns false. + +
delete: +
+Currently unimplemented. I don't remove line items because there would then +be no record the items ever existed (which is bad, no?) + +
replace OLD_RECORD: +
+Currently unimplemented. This would be even more of an accounting nightmare +than deleteing the items. Just don't do it. + +
check: +
+Checks all fields to make sure this is a valid line item. If there is an +error, returns the error, otherwise returns false. Called by the insert +method. + +

VERSION

+$Id: cust_bill_pkg.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

NAME

+FS::cust_credit - Object methods for cust_credit records + +

SYNOPSIS

  use FS::cust_credit;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::cust_credit object represents a credit. FS::cust_credit inherits +from FS::Record. The following fields are currently supported: + +

crednum - primary key (assigned automatically for new credits): +
custnum - customer (see FS::cust_main): +
amount - amount of the credit: +
credited - how much of this credit that is still outstanding, which is +amount minus all refunds (see FS::cust_refund).: +
_date - specified as a UNIX timestamp; see perlfunc/"time". Also see +Time::Local and Date::Parse for conversion functions.: +
otaker - order taker (assigned automatically, see FS::UID): +
reason - text: +

METHODS

new HASHREF

+Creates a new credit. To add the credit to the database, see insert. + +

insert

+Adds this credit to the database (``Posts'' the credit). If there is an +error, returns the error, otherwise returns false. + +

+When adding new invoices, credited must be amount (or null, in which case +it is automatically set to amount). + +

delete

+Currently unimplemented. + +

replace OLD_RECORD

+Replaces the OLD_RECORD with this one in the database. If there is an +error, returns the error, otherwise returns false. + +

+Only credited may be changed. Credited is normally updated by creating and +inserting a refund (see FS::cust_refund). + +

check

+Checks all fields to make sure this is a valid credit. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

VERSION

+$Id: cust_credit.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The delete method. + +

NAME

+FS::cust_main - Object methods for cust_main records + +

SYNOPSIS

  use FS::cust_main;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  @cust_pkg = $record->all_pkgs;
+

  @cust_pkg = $record->ncancelled_pkgs;
+

  $error = $record->bill;
+  $error = $record->bill %options;
+  $error = $record->bill 'time' => $time;
+

  $error = $record->collect;
+  $error = $record->collect %options;
+  $error = $record->collect 'invoice_time'   => $time,
+                            'batch_card'     => 'yes',
+                            'report_badcard' => 'yes',
+                          ;
+

DESCRIPTION

+An FS::cust_main object represents a customer. FS::cust_main inherits from +FS::Record. The following fields are currently supported: + +

custnum - primary key (assigned automatically for new customers): +
agentnum - agent (see FS::agent): +
refnum - referral (see FS::part_referral): +
first - name: +
last - name: +
ss - social security number (optional): +
company - (optional): +
address1: +
address2 - (optional): +
city: +
county - (optional, see FS::cust_main_county): +
state - (see FS::cust_main_county): +
zip: +
country - (see FS::cust_main_county): +
daytime - phone (optional): +
night - phone (optional): +
fax - phone (optional): +
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free): +
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username): +
paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy: +
payname - name on card or billing name: +
tax - tax exempt, empty or `Y': +
otaker - order taker (assigned automatically, see FS::UID): +

METHODS

new HASHREF

+Creates a new customer. To add the customer 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 customer to the database. If there is an error, returns the +error, otherwise returns false. + +

delete NEW_CUSTNUM

+This deletes the customer. If there is an error, returns the error, +otherwise returns false. + +

+This will completely remove all traces of the customer record. This is not +what you want when a customer cancels service; for that, cancel all of the +customer's packages (see cancel). + +

+If the customer has any packages, you need to pass a new (valid) customer +number for those packages to be transferred to. + +

+You can't delete a customer with invoices (see FS::cust_bill), or credits (see FS::cust_credit). + +

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

all_pkgs

+Returns all packages (see FS::cust_pkg) for this customer. + +

ncancelled_pkgs

+Returns all non-cancelled packages (see FS::cust_pkg) for this customer. + +

bill OPTIONS

+Generates invoices (see FS::cust_bill) for this customer. Usually used in conjunction with the collect method. + +

+The only currently available option is `time', which bills the customer as +if it were that time. It is specified as a UNIX timestamp; see +perlfunc). Also see Time::Local and Date::Parse for conversion functions. + +

+If there is an error, returns the error, otherwise returns false. + +

collect OPTIONS

+(Attempt to) collect money for this customer's outstanding invoices (see +FS::cust_bill). Usually used after the bill method. + +

+Depending on the value of `payby', this may print an invoice (`BILL'), +charge a credit card (`CARD'), or just add any necessary (pseudo-)payment +(`COMP'). + +

+If there is an error, returns the error, otherwise returns false. + +

+Currently available options are: + +

+invoice_time - Use this time when deciding when to print invoices and late +notices on those invoices. The default is now. It is specified as a UNIX +timestamp; see perlfunc). Also see Time::Local and Date::Parse +for conversion functions. + +

+batch_card - Set this true to batch cards (see the cust_pay_batch manpage). By default, cards are processed immediately, which will generate an +error if CyberCash is not installed. + +

+report_badcard - Set this true if you want bad card transactions to return +an error. By default, they don't. + +

total_owed

+Returns the total owed for this customer on all invoices (see FS::cust_bill). + +

total_credited

+Returns the total credits (see FS::cust_credit) for this customer. + +

balance

+Returns the balance for this customer (total owed minus total credited). + +

invoicing_list [ ARRAYREF ]

+If an arguement is given, sets these email addresses as invoice recipients +(see FS::cust_main_invoice). Errors are not fatal and are not reported (except as warnings), so use +check_invoicing_list first. + +

+Returns a list of email addresses (with svcnum entries expanded). + +

+Note: You can clear the invoicing list by passing an empty ARRAYREF. You +can check it without disturbing anything by passing nothing. + +

+This interface may change in the future. + +

check_invoicing_list ARRAYREF

+Checks these arguements as valid input for the invoicing_list method. If +there is an error, returns the error, otherwise returns false. + +

VERSION

+$Id: cust_main.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The delete method. + +

+The delete method should possibly take an FS::cust_main object reference +instead of a scalar customer number. + +

+Bill and collect options should probably be passed as references instead of +a list. + +

+CyberCash v2 forces us to define some variables in package main. + +

+There should probably be a configuration file with a list of allowed credit +card types. + +

+CyberCash is the only processor. + +

+No multiple currency support (probably a larger project than just this +module). + +

NAME

+FS::cust_main_county - Object methods for cust_main_county objects + +

SYNOPSIS

  use FS::cust_main_county;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::cust_main_county object represents a tax rate, defined by locale. +FS::cust_main_county inherits from FS::Record. The following fields are +currently supported: + +

taxnum - primary key (assigned automatically for new tax rates): +
state: +
county: +
country: +
tax - percentage: +

METHODS

new HASHREF: +
+Creates a new tax rate. To add the tax rate to the database, see insert. + +
insert: +
+Adds this tax rate to the database. If there is an error, returns the +error, otherwise returns false. + +
delete: +
+Deletes this tax rate from the database. If there is an error, returns the +error, otherwise returns false. + +
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 tax rate. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

VERSION

+$Id: cust_main_county.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

NAME

+FS::cust_main_invoice - Object methods for cust_main_invoice records + +

SYNOPSIS

  use FS::cust_main_invoice;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $email_address = $record->address;
+

DESCRIPTION

+An FS::cust_main_invoice object represents an invoice destination. +FS::cust_main_invoice inherits from FS::Record. The following fields are +currently supported: + +

destnum - primary key: +
custnum - customer (see FS::cust_main): +
dest - Invoice destination: If numeric, a <a href="#svc_acct">svcnum</a>, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist): +

METHODS

new HASHREF

+Creates a new invoice destination. To add the invoice destination 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 invoice destination. If +there is an error, returns the error, otherwise returns false. Called by +the insert and repalce methods. + +

checkdest

+Checks the dest field only. + +

address

+Returns the literal email address for this record (or `POST'). + +

VERSION

+$Id: cust_main_invoice.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

NAME

+FS::cust_pay - Object methods for cust_pay objects + +

SYNOPSIS

  use FS::cust_pay;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::cust_pay object represents a payment. FS::cust_pay inherits from +FS::Record. The following fields are currently supported: + +

paynum - primary key (assigned automatically for new payments): +
invnum - Invoice (see FS::cust_bill): +
paid - Amount of this payment: +
_date - specified as a UNIX timestamp; see perlfunc/"time". Also see +Time::Local and Date::Parse for conversion functions.: +
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free): +
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username): +
paybatch - text field for tracking card processing: +

METHODS

new HASHREF: +
+Creates a new payment. To add the payment to the databse, see insert. + +
insert: +
+Adds this payment to the databse, and updates the invoice (see +FS::cust_bill). + +
delete: +
+Currently unimplemented (accounting reasons). + +
replace OLD_RECORD: +
+Currently unimplemented (accounting reasons). + +
check: +
+Checks all fields to make sure this is a valid payment. If there is an +error, returns the error, otherwise returns false. Called by the insert +method. + +

VERSION

+$Id: cust_pay.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+Delete and replace methods. + +

NAME

+FS::cust_pay_batch - Object methods for batch cards + +

SYNOPSIS

  use FS::cust_pay_batch;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::cust_pay_batch object represents a credit card transaction ready to +be batched (sent to a processor). FS::cust_pay_batch inherits from +FS::Record. Typically called by the collect method of an FS::cust_main +object. The following fields are currently supported: + +

trancode - 77 for charges: +
cardnum: +
exp - card expiration: +
amount: +
invnum - invoice: +
custnum - customer: +
payname - name on card: +
first - name: +
last - name: +
address1: +
address2: +
city: +
state: +
zip: +
country: +

METHODS

new HASHREF

+Creates a new record. To add the record 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. If there is an error, returns the +error, otherwise returns false. + +

replace OLD_RECORD

+#inactive # #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 transaction. If there is an +error, returns the error, otherwise returns false. Called by the insert and +repalce methods. + +

VERSION

+$Id: cust_pay_batch.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+There should probably be a configuration file with a list of allowed credit +card types. + +

NAME

+FS::cust_pkg - Object methods for cust_pkg objects + +

SYNOPSIS

  use FS::cust_pkg;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $error = $record->cancel;
+

  $error = $record->suspend;
+

  $error = $record->unsuspend;
+

  $part_pkg = $record->part_pkg;
+

  @labels = $record->labels;
+

  $error = FS::cust_pkg::order( $custnum, \@pkgparts );
+  $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
+

DESCRIPTION

+An FS::cust_pkg object represents a customer billing item. FS::cust_pkg +inherits from FS::Record. The following fields are currently supported: + +

pkgnum - primary key (assigned automatically for new billing items): +
custnum - Customer (see FS::cust_main): +
pkgpart - Billing item definition (see FS::part_pkg): +
setup - date: +
bill - date: +
susp - date: +
expire - date: +
cancel - date: +
otaker - order taker (assigned automatically if null, see FS::UID): +

+Note: setup, bill, susp, expire and cancel are specified as UNIX +timestamps; see perlfunc. Also see Time::Local and Date::Parse for conversion functions. + +

METHODS

new HASHREF

+Create a new billing item. To add the item to the database, see insert. + +

insert

+Adds this billing item to the database (``Orders'' the item). If there is +an error, returns the error, otherwise returns false. + +

+sub insert { my $self = shift; + +

  # custnum might not have have been defined in sub check (for one-shot new
+  # customers), so check it here instead
+

  my $error = $self->ut_number('custnum');
+  return $error if $error
+

  return "Unknown customer"
+    unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
+

  $self->SUPER::insert;
+

+} + +

delete

+Currently unimplemented. You don't want to delete billing items, because +there would then be no record the customer ever purchased the item. +Instead, see the cancel method. + +

replace OLD_RECORD

+Replaces the OLD_RECORD with this one in the database. If there is an +error, returns the error, otherwise returns false. + +

+Currently, custnum, setup, bill, susp, expire, and cancel may be changed. + +

+Changing pkgpart may have disasterous effects. See the order subroutine. + +

+setup and bill are normally updated by calling the bill method of a +customer object (see FS::cust_main). + +

+suspend is normally updated by the suspend and unsuspend methods. + +

+cancel is normally updated by the cancel method (and also the order +subroutine in some cases). + +

check

+Checks all fields to make sure this is a valid billing item. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

cancel

+Cancels and removes all services (see FS::cust_svc and FS::part_svc) in this package, then cancels the package itself (sets the cancel field +to now). + +

+If there is an error, returns the error, otherwise returns false. + +

suspend

+Suspends all services (see FS::cust_svc and FS::part_svc) in this package, then suspends the package itself (sets the susp field to +now). + +

+If there is an error, returns the error, otherwise returns false. + +

unsuspend

+Unsuspends all services (see FS::cust_svc and FS::part_svc) in this package, then unsuspends the package itself (clears the susp +field). + +

+If there is an error, returns the error, otherwise returns false. + +

part_pkg

+Returns the definition for this billing item, as an FS::part_pkg object +(see +FS::part_pkg). + +

labels

+Returns a list of lists, calling the label method for all services (see FS::cust_svc) of this billing item. + +

SUBROUTINES

order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF ]

+CUSTNUM is a customer (see FS::cust_main) + +

+PKGPARTS is a list of pkgparts specifying the the billing item definitions +(see +FS::part_pkg) to order for this customer. Duplicates are of course permitted. + +

+REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items +to remove for this customer. The services (see FS::cust_svc) are moved to the new billing items. An error is returned if this is not +possible (see +FS::pkg_svc). + +

VERSION

+$Id: cust_pkg.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+sub order is not OO. Perhaps it should be moved to FS::cust_main and made +so? + +

+In sub order, the @pkgparts array (passed by reference) is +clobbered. + +

+Also in sub order, no money is adjusted. Once FS::part_pkg defines a +standard method to pass dates to the recur_prog expression, it should do +so. + +

+FS::svc_acct, FS::svc_acct_sm, and FS::svc_domain are loaded via 'use' at +compile time, rather than via 'require' in sub { setup, suspend, unsuspend, +cancel } because they use %FS::UID::callback to load configuration values. +Probably need a subroutine which decides what to do based on whether or not +we've fetched the user yet, rather than a hash. See FS::UID and the TODO. + +

NAME

+FS::cust_refund - Object method for cust_refund objects + +

SYNOPSIS

  use FS::cust_refund;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::cust_refund represents a refund. FS::cust_refund inherits from +FS::Record. The following fields are currently supported: + +

refundnum - primary key (assigned automatically for new refunds): +
crednum - Credit (see FS::cust_credit): +
refund - Amount of the refund: +
_date - specified as a UNIX timestamp; see perlfunc/"time". Also see +Time::Local and Date::Parse for conversion functions.: +
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free): +
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username): +
otaker - order taker (assigned automatically, see FS::UID): +

METHODS

new HASHREF: +
+Creates a new refund. To add the refund to the database, see insert. + +
insert: +
+Adds this refund to the database, and updates the credit (see +FS::cust_credit). + +
delete: +
+Currently unimplemented (accounting reasons). + +
replace OLD_RECORD: +
+Currently unimplemented (accounting reasons). + +
check: +
+Checks all fields to make sure this is a valid refund. If there is an +error, returns the error, otherwise returns false. Called by the insert +method. + +

VERSION

+$Id: cust_refund.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+Delete and replace methods. + +

NAME

+FS::cust_svc - Object method for cust_svc objects + +

SYNOPSIS

  use FS::cust_svc;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  ($label, $value) = $record->label;
+

DESCRIPTION

+An FS::cust_svc represents a service. FS::cust_svc inherits from +FS::Record. The following fields are currently supported: + +

svcnum - primary key (assigned automatically for new services): +
pkgnum - Package (see FS::cust_pkg): +
svcpart - Service definition (see FS::part_svc): +

METHODS

new HASHREF

+Creates a new service. To add the refund to the database, see insert. Services are normally created by creating FS::svc_ objects (see +FS::svc_acct, FS::svc_domain, and FS::svc_acct_sm, among others). + +

insert

+Adds this service to the database. If there is an error, returns the error, +otherwise returns false. + +

delete

+Deletes this service from the database. If there is an error, returns the +error, otherwise returns false. + +

+Called by the cancel method of the package (see FS::cust_pkg). + +

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

label

+Returns a list consisting of: - The name of this service (from part_svc) - +A meaningful identifier (username, domain, or mail alias) - The table name +(i.e. svc_domain) for this service + +

VERSION

+$Id: cust_svc.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+Behaviour of changing the svcpart of cust_svc records is undefined and +should possibly be prohibited, and pkg_svc records are not checked. + +

+pkg_svc records are not checked in general (here). + +

+Deleting this record doesn't check or delete the svc_* record associated +with this record. + +

NAME

+FS::dbdef - Database objects + +

SYNOPSIS

  use FS::dbdef;
+

  $dbdef = new FS::dbdef (@dbdef_table_objects);
+  $dbdef = load FS::dbdef "filename";
+

  $dbdef->save("filename");
+

  $dbdef->addtable($dbdef_table_object);
+

  @table_names = $dbdef->tables;
+

  $FS_dbdef_table_object = $dbdef->table;
+

DESCRIPTION

+FS::dbdef objects are collections of FS::dbdef_table objects and represnt a +database (a collection of tables). + +

METHODS

new TABLE, TABLE, ...

+Creates a new FS::dbdef object + +

load FILENAME

+Loads an FS::dbdef object from a file. + +

save FILENAME

+Saves an FS::dbdef object to a file. + +

addtable TABLE

+Adds this FS::dbdef_table object. + +

tables

+Returns the names of all tables. + +

table TABLENAME

+Returns the named FS::dbdef_table object. + +

BUGS

+Each FS::dbdef object should have a name which corresponds to its name +within the SQL database engine. + +

NAME

+FS::dbdef_colgroup - Column group objects + +

SYNOPSIS

  use FS::dbdef_colgroup;
+

  $colgroup = new FS::dbdef_colgroup ( $lol );
+  $colgroup = new FS::dbdef_colgroup (
+    [
+      [ 'single_column' ],
+      [ 'multiple_columns', 'another_column', ],
+    ]
+  );
+

  @sql_lists = $colgroup->sql_list;
+

  @singles = $colgroup->singles;
+

DESCRIPTION

+FS::dbdef_colgroup objects represent sets of sets of columns. + +

METHODS

new: +
+Creates a new FS::dbdef_colgroup object. + +
sql_list: +
+Returns a flat list of comma-separated values, for SQL statements. + +
singles: +
+Returns a flat list of all single item lists. + +

BUGS

NAME

+FS::dbdef_column - Column object + +

SYNOPSIS

  use FS::dbdef_column;
+

  $column_object = new FS::dbdef_column ( $name, $sql_type, '' );
+  $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL' );
+  $column_object = new FS::dbdef_column ( $name, $sql_type, '', $length );
+  $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL', $length );
+

  $name = $column_object->name;
+  $column_object->name ( 'name' );
+

  $name = $column_object->type;
+  $column_object->name ( 'sql_type' );
+

  $name = $column_object->null;
+  $column_object->name ( 'NOT NULL' );
+

  $name = $column_object->length;
+  $column_object->name ( $length );
+

  $sql_line = $column->line;
+  $sql_line = $column->line $datasrc;
+

DESCRIPTION

+FS::dbdef::column objects represend columns in tables (see FS::dbdef_table). + +

METHODS

new

+Creates a new FS::dbdef_column object. + +

name

+Returns or sets the column name. + +

type

+Returns or sets the column type. + +

null

+Returns or sets the column null flag. + +

type

+Returns or sets the column length. + +

line [ $datasrc ]

+Returns an SQL column definition. + +

+If passed a DBI $datasrc specifying DBD::mysql or DBD::Pg, will use engine-specific syntax. + +

BUGS

VERSION

+$Id: dbdef_column.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + + + + diff --git a/htdocs/docs/man/FS/dbdef_index.html b/htdocs/docs/man/FS/dbdef_index.html new file mode 100644 index 000000000..7a9e5039e --- /dev/null +++ b/htdocs/docs/man/FS/dbdef_index.html @@ -0,0 +1,58 @@ + + +FS::dbdef_unique.pm - Index object + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
BUGS +
SEE ALSO +

+ + +

NAME

+FS::dbdef_unique.pm - Index object + +

SYNOPSIS

  use FS::dbdef_index;
+

    # see FS::dbdef_colgroup methods
+

DESCRIPTION

+FS::dbdef_unique objects represent the (non-unique) indices of a table (FS::dbdef_table). FS::dbdef_unique inherits from FS::dbdef_colgroup. + +

BUGS

+Is this empty subclass needed? + +

NAME

+FS::dbdef_table - Table objects + +

SYNOPSIS

  use FS::dbdef_table;
+

  $dbdef_table = new FS::dbdef_table (
+    "table_name",
+    "primary_key",
+    $FS_dbdef_unique_object,
+    $FS_dbdef_index_object,
+    @FS_dbdef_column_objects,
+  );
+

  $dbdef_table->addcolumn ( $FS_dbdef_column_object );
+

  $table_name = $dbdef_table->name;
+  $dbdef_table->name ("table_name");
+

  $table_name = $dbdef_table->primary_keye;
+  $dbdef_table->primary_key ("primary_key");
+

  $FS_dbdef_unique_object = $dbdef_table->unique;
+  $dbdef_table->unique ( $FS_dbdef_unique_object );
+

  $FS_dbdef_index_object = $dbdef_table->index;
+  $dbdef_table->index ( $FS_dbdef_index_object );
+

  @column_names = $dbdef->columns;
+

  $FS_dbdef_column_object = $dbdef->column;
+

  @sql_statements = $dbdef->sql_create_table;
+  @sql_statements = $dbdef->sql_create_table $datasrc;
+

DESCRIPTION

+FS::dbdef_table objects represent a single database table. + +

METHODS

new

+Creates a new FS::dbdef_table object. + +

addcolumn

+Adds this FS::dbdef_column object. + +

name

+Returns or sets the table name. + +

primary_key

+Returns or sets the primary key. + +

unique

+Returns or sets the FS::dbdef_unique object. + +

index

+Returns or sets the FS::dbdef_index object. + +

columns

+Returns a list consisting of the names of all columns. + +

column "column"

+Returns the column object (see FS::dbdef_column) for ``column''. + +

sql_create_table [ $datasrc ]

+Returns an array of SQL statments to create this table. + +

+If passed a DBI $datasrc specifying DBD::mysql, will use MySQL-specific syntax. Non-standard syntax for other engines (if +applicable) may also be supported in the future. + +

BUGS

VERSION

+$Id: dbdef_table.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + + + + diff --git a/htdocs/docs/man/FS/dbdef_unique.html b/htdocs/docs/man/FS/dbdef_unique.html new file mode 100644 index 000000000..73c885c75 --- /dev/null +++ b/htdocs/docs/man/FS/dbdef_unique.html @@ -0,0 +1,58 @@ + + +FS::dbdef_unique.pm - Unique object + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
BUGS +
SEE ALSO +

+ + +

NAME

+FS::dbdef_unique.pm - Unique object + +

SYNOPSIS

  use FS::dbdef_unique;
+

  # see FS::dbdef_colgroup methods
+

DESCRIPTION

+FS::dbdef_unique objects represent the unique indices of a database table (FS::dbdef_table). FS::dbdef_unique inherits from FS::dbdef_colgroup. + +

BUGS

+Is this empty subclass needed? + +

NAME

+FS::part_pkg - Object methods for part_pkg objects + +

SYNOPSIS

  use FS::part_pkg;
+

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

  $custom_record = $template_record->clone;
+

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  @pkg_svc = $record->pkg_svc;
+

  $svcnum = $record->svcpart;
+  $svcnum = $record->svcpart( 'svc_acct' );
+

DESCRIPTION

+An FS::part_pkg object represents a billing item definition. FS::part_pkg +inherits from FS::Record. The following fields are currently supported: + +

pkgpart - primary key (assigned automatically for new billing item definitions): +
pkg - Text name of this billing item definition (customer-viewable): +
comment - Text name of this billing item definition (non-customer-viewable): +
setup - Setup fee: +
freq - Frequency of recurring fee: +
recur - Recurring fee: +

+setup and recur are evaluated as Safe perl expressions. You can use numbers +just as you would normally. More advanced semantics are not yet defined. + +

METHODS

new HASHREF: +
+Creates a new billing item definition. To add the billing item definition +to the database, see insert. + +
clone: +
+An alternate constructor. Creates a new billing item definition by +duplicating an existing definition. A new pkgpart is assigned and `(CUSTOM) +' is prepended to the comment field. To add the billing item definition to +the database, see +insert. + +
insert: +
+Adds this billing item definition to the database. If there is an error, +returns the error, otherwise returns false. + +
delete: +
+Currently unimplemented. + +
replace OLD_RECORD: +
+Replaces 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 billing item definition. If +there is an error, returns the error, otherwise returns false. Called by +the insert and replace methods. + +
pkg_svc: +
+Returns all FS::pkg_svc objects (see FS::pkg_svc) for this package definition. + +
svcpart [ SVCDB ]: +
+Returns the svcpart of a single service definition (see FS::part_svc) associated with this billing item definition (see FS::pkg_svc). Returns false if there not exactly one service definition with quantity +1, or if SVCDB is specified and does not match the svcdb of the service +definition, + +

VERSION

+$Id: part_pkg.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The delete method is unimplemented. + +

+setup and recur semantics are not yet defined (and are implemented in +FS::cust_bill. hmm.). + +

NAME

+FS::part_referral - Object methods for part_referral objects + +

SYNOPSIS

  use FS::part_referral;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::part_referral represents a referral - where a customer heard of your +services. This can be used to track the effectiveness of a particular piece +of advertising, for example. FS::part_referral inherits from FS::Record. +The following fields are currently supported: + +

refnum - primary key (assigned automatically for new referrals): +
referral - Text name of this referral: +

METHODS

new HASHREF: +
+Creates a new referral. To add the referral to the database, see insert. + +
insert: +
+Adds this referral to the database. If there is an error, returns the +error, otherwise returns false. + +
delete: +
+Currently unimplemented. + +
replace OLD_RECORD: +
+Replaces 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 referral. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

VERSION

+$Id: part_referral.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The delete method is unimplemented. + +

NAME

+FS::part_svc - Object methods for part_svc objects + +

SYNOPSIS

  use FS::part_svc;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::part_svc represents a service definition. FS::part_svc inherits from +FS::Record. The following fields are currently supported: + +

svcpart - primary key (assigned automatically for new service definitions): +
svc - text name of this service definition: +
svcdb - table used for this service. See FS::svc_acct, +FS::svc_domain, and FS::svc_acct_sm, among others.: +
svcdb__field - Default or fixed value for field in svcdb.: +
svcdb__field_flag - defines svcdb__field action: null, `D' for default, or `F' for fixed: +

METHODS

new HASHREF: +
+Creates a new service definition. To add the service definition to the +database, see insert. + +
insert: +
+Adds this service definition to the database. If there is an error, returns +the error, otherwise returns false. + +
delete: +
+Currently unimplemented. + +
replace OLD_RECORD: +
+Replaces 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 service definition. If there +is an error, returns the error, otherwise returns false. Called by the +insert and replace methods. + +

VERSION

+$Id: part_svc.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+Delete is unimplemented. + +

+The list of svc_* tables is hardcoded. When svc_acct_pop is renamed, this +should be fixed. + +

NAME

+FS::pkg_svc - Object methods for pkg_svc records + +

SYNOPSIS

  use FS::pkg_svc;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $part_pkg = $record->part_pkg;
+

  $part_svc = $record->part_svc;
+

DESCRIPTION

+An FS::pkg_svc record links a billing item definition (see FS::part_pkg) to a service definition (see FS::part_svc). FS::pkg_svc inherits from FS::Record. The following fields are currently +supported: + +

pkgpart - Billing item definition (see FS::part_pkg): +
svcpart - Service definition (see FS::part_svc): +
quantity - Quantity of this service definition that this billing item +definition includes: +

METHODS

new HASHREF: +
+Create a new record. To add the record to the database, see insert. + +
insert: +
+Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +
delete: +
+Deletes this record from the database. If there is an error, returns the +error, otherwise returns false. + +
replace OLD_RECORD: +
+Replaces 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 record. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +
part_pkg: +
+Returns the FS::part_pkg object (see FS::part_pkg). + +
part_svc: +
+Returns the FS::part_svc object (see FS::part_svc). + +

VERSION

+$Id: pkg_svc.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

NAME

+FS::svc_Common - Object method for all svc_ records + +

SYNOPSIS

+use FS::svc_Common; + +

+@ISA = qw( FS::svc_Common ); + +

DESCRIPTION

+FS::svc_Common is intended as a base class for table-specific classes to +inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record. + +

METHODS

insert

+Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +

+The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted. + +

delete

+Deletes this account from the database. If there is an error, returns the +error, otherwise returns false. + +

+The corresponding FS::cust_svc record will be deleted as well. + +

setfixed

+Sets any fixed fields for this service (see FS::part_svc). If there is an error, returns the error, otherwise returns the +FS::part_svc object (use ref() to test the return). Usually +called by the check method. + +

setdefault

+Sets all fields to their defaults (see FS::part_svc), overriding their current values. If there is an error, returns the +error, otherwise returns the FS::part_svc object (use ref() to +test the return). + +

suspend

unsuspend

cancel

+Stubs - return false (no error) so derived classes don't need to define +these methods. Called by the cancel method of FS::cust_pkg (see FS::cust_pkg). + +

VERSION

+$Id: svc_Common.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The setfixed method return value. + +

+The new method should set defaults from part_svc (like the check method +sets fixed values)? + +

NAME

+FS::svc_acct - Object methods for svc_acct records + +

SYNOPSIS

  use FS::svc_acct;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $error = $record->suspend;
+

  $error = $record->unsuspend;
+

  $error = $record->cancel;
+

DESCRIPTION

+An FS::svc_acct object represents an account. FS::svc_acct inherits from +FS::svc_Common. The following fields are currently supported: + +

svcnum - primary key (assigned automatcially for new accounts): +
username: +
_password - generated if blank: +
popnum - Point of presence (see FS::svc_acct_pop): +
uid: +
gid: +
finger - GECOS: +
dir - set automatically if blank (and uid is not): +
shell: +
quota - (unimplementd): +
slipip - IP address: +
radius_Radius_Attribute - Radius-Attribute: +

METHODS

new HASHREF

+Creates a new account. To add the account to the database, see insert. + +

insert

+Adds this account to the database. If there is an error, returns the error, +otherwise returns false. + +

+The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted. + +

+If the configuration value (see FS::Conf) shellmachine exists, and the username, uid, and dir fields are defined, +the command + +

  useradd -d $dir -m -s $shell -u $uid $username
+

+is executed on shellmachine via ssh. This behaviour can be surpressed by +setting $FS::svc_acct::nossh_hack true. + +

delete

+Deletes this account from the database. If there is an error, returns the +error, otherwise returns false. + +

+The corresponding FS::cust_svc record will be deleted as well. + +

+If the configuration value (see FS::Conf) shellmachine exists, the command: + +

  userdel $username
+

+is executed on shellmachine via ssh. This behaviour can be surpressed by +setting $FS::svc_acct::nossh_hack true. + +

replace OLD_RECORD

+Replaces OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +

+If the configuration value (see FS::Conf) shellmachine exists, and the dir field has changed, the command: + +

  [ -d $old_dir ] && (
+    chmod u+t $old_dir;
+    umask 022;
+    mkdir $new_dir;
+    cd $old_dir;
+    find . -depth -print | cpio -pdm $new_dir;
+    chmod u-t $new_dir;
+    chown -R $uid.$gid $new_dir;
+    rm -rf $old_dir
+  )
+

+is executed on shellmachine via ssh. This behaviour can be surpressed by +setting $FS::svc_acct::nossh_hack true. + +

suspend

+Suspends this account by prefixing *SUSPENDED* to the password. If there is +an error, returns the error, otherwise returns false. + +

+Called by the suspend method of FS::cust_pkg (see FS::cust_pkg). + +

unsuspend

+Unsuspends this account by removing *SUSPENDED* from the password. If there +is an error, returns the error, otherwise returns false. + +

+Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg). + +

cancel

+Just returns false (no error) for now. + +

+Called by the cancel method of FS::cust_pkg (see FS::cust_pkg). + +

check

+Checks all fields to make sure this is a valid service. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

+Sets any fixed values; see FS::part_svc. + +

VERSION

+$Id: svc_acct.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The remote commands should be configurable. + +

+The bits which ssh should fork before doing so. + +

+The $recref stuff in sub check should be cleaned up. + +

NAME

+FS::svc_acct_pop - Object methods for svc_acct_pop records + +

SYNOPSIS

  use FS::svc_acct_pop;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::svc_acct object represents an point of presence. FS::svc_acct_pop +inherits from FS::Record. The following fields are currently supported: + +

popnum - primary key (assigned automatically for new accounts): +
city: +
state: +
ac - area code: +
exch - exchange: +

METHODS

new HASHREF: +
+Creates a new point of presence (if only it were that easy!). To add the +point of presence to the database, see insert. + +
insert: +
+Adds this point of presence to the database. If there is an error, returns +the error, otherwise returns false. + +
delete: +
+Removes this point of presence from the database. + +
replace OLD_RECORD: +
+Replaces 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 point of presence. If there +is an error, returns the error, otherwise returns false. Called by the +insert and replace methods. + +

VERSION

+$Id: svc_acct_pop.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+It should be renamed to part_pop. + +

NAME

+FS::svc_acct_sm - Object methods for svc_acct_sm records + +

SYNOPSIS

  use FS::svc_acct_sm;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $error = $record->suspend;
+

  $error = $record->unsuspend;
+

  $error = $record->cancel;
+

DESCRIPTION

+An FS::svc_acct object represents a virtual mail alias. FS::svc_acct +inherits from FS::Record. The following fields are currently supported: + +

svcnum - primary key (assigned automatcially for new accounts): +
domsvc - svcnum of the virtual domain (see FS::svc_domain): +
domuid - uid of the target account (see FS::svc_acct): +
domuser - virtual username: +

METHODS

new HASHREF

+Creates a new virtual mail alias. To add the virtual mail alias to the +database, see insert. + +

insert

+Adds this virtual mail alias to the database. If there is an error, returns +the error, otherwise returns false. + +

+The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted. + +

+If the configuration values (see FS::Conf) shellmachine and qmailmachines exist, and domuser is `*' (meaning a +catch-all mailbox), the command: + +

  [ -e $dir/.qmail-$qdomain-default ] || {
+    touch $dir/.qmail-$qdomain-default;
+    chown $uid:$gid $dir/.qmail-$qdomain-default;
+  }
+

+is executed on shellmachine via ssh (see dot-qmail). This behaviour can be surpressed by setting $FS::svc_acct_sm::nossh_hack +true. + +

delete

+Deletes this virtual mail alias from the database. If there is an error, +returns the error, otherwise returns false. + +

+The corresponding FS::cust_svc record will be deleted as well. + +

replace OLD_RECORD

+Replaces OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +

suspend

+Just returns false (no error) for now. + +

+Called by the suspend method of FS::cust_pkg (see FS::cust_pkg). + +

unsuspend

+Just returns false (no error) for now. + +

+Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg). + +

cancel

+Just returns false (no error) for now. + +

+Called by the cancel method of FS::cust_pkg (see FS::cust_pkg). + +

check

+Checks all fields to make sure this is a valid virtual mail alias. If there +is an error, returns the error, otherwise returns false. Called by the +insert and replace methods. + +

+Sets any fixed values; see FS::part_svc. + +

VERSION

+$Id: svc_acct_sm.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+The remote commands should be configurable. + +

+The $recref stuff in sub check should be cleaned up. + +

NAME

+FS::svc_domain - Object methods for svc_domain records + +

SYNOPSIS

  use FS::svc_domain;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $error = $record->suspend;
+

  $error = $record->unsuspend;
+

  $error = $record->cancel;
+

DESCRIPTION

+An FS::svc_domain object represents a domain. FS::svc_domain inherits from +FS::svc_Common. The following fields are currently supported: + +

svcnum - primary key (assigned automatically for new accounts): +
domain: +

METHODS

new HASHREF

+Creates a new domain. To add the domain to the database, see insert. + +

insert

+Adds this domain to the database. If there is an error, returns the error, +otherwise returns false. + +

+The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted. + +

+The additional field action should be set to N for new domains or M +for transfers. + +

+A registration or transfer email will be submitted unless +$FS::svc_domain::whois_hack is true. + +

+The additional field email can be used to manually set the admin contact email address on this email. +Otherwise, the svc_acct records for this package (see FS::cust_pkg) are searched. If there is exactly one svc_acct record in the same +package, it is automatically used. Otherwise an error is returned. + +

delete

+Deletes this domain from the database. If there is an error, returns the +error, otherwise returns false. + +

+The corresponding FS::cust_svc record will be deleted as well. + +

replace OLD_RECORD

+Replaces OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +

suspend

+Just returns false (no error) for now. + +

+Called by the suspend method of FS::cust_pkg (see FS::cust_pkg). + +

unsuspend

+Just returns false (no error) for now. + +

+Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg). + +

cancel

+Just returns false (no error) for now. + +

+Called by the cancel method of FS::cust_pkg (see FS::cust_pkg). + +

check

+Checks all fields to make sure this is a valid domain. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

+Sets any fixed values; see FS::part_svc. + +

whois

+Returns the Net::Whois object corresponding to this domain, or undef if the +domain is not found in whois. + +

+(If $FS::svc_domain::whois_hack is true, returns that in all cases +instead.) + +

_whois

+Depriciated. + +

submit_internic

+Submits a registration email for this domain. + +

VERSION

+$Id: svc_domain.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+All BIND/DNS fields should be included (and exported). + +

+Delete doesn't send a registration template. + +

+All registries should be supported. + +

+Should change action to a real field. + +

+The $recref stuff in sub check should be cleaned up. + +

NAME

+FS::type_pkgs - Object methods for type_pkgs records + +

SYNOPSIS

  use FS::type_pkgs;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

DESCRIPTION

+An FS::type_pkgs record links an agent type (see FS::agent_type) to a billing item definition (see FS::part_pkg). FS::type_pkgs inherits from FS::Record. The following fields are +currently supported: + +

typenum - Agent type, see FS::agent_type: +
pkgpart - Billing item definition, see FS::part_pkg: +

METHODS

new HASHREF: +
+Create a new record. To add the record to the database, see insert. + +
insert: +
+Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +
delete: +
+Deletes this record from the database. If there is an error, returns the +error, otherwise returns false. + +
replace OLD_RECORD: +
+Replaces 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 record. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

VERSION

+$Id: type_pkgs.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +