Freeside:4:Documentation:Developer/FS/svc acct pop

From Freeside
Jump to: navigation, search

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;

 $html = FS::svc_acct_pop::popselector( $popnum, $state );

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; loc - rest of number

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.
text
Returns:
"$city, $state ($ac)/$exch"

SUBROUTINES

popselector [ POPNUM [ STATE ] ]

BUGS

It should be renamed to part_pop.

popselector? putting web ui components in here? they should probably live somewhere else...

popselector: pull special-case for 0 & 1 pop code out from signup.cgi

SEE ALSO

FS::Record, FS::svc_acct, FS::part_pop_local, schema.html from the base documentation.