Difference between revisions of "Freeside:3:Documentation:Developer/FS/radius usergroup"

Latest revision as of 20:06, 27 June 2012

NAME

FS::radius_usergroup - Object methods for radius_usergroup records

SYNOPSIS

 use FS::radius_usergroup;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::radius_usergroup object links an account (see FS::svc_acct) with a RADIUS group (see FS::radius_group). FS::radius_usergroup inherits from FS::Record. The following fields are currently supported:

usergroupnum - primary key; svcnum - Account (see FS::svc_acct).; groupnum - RADIUS group (see FS::radius_group).

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.

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

svc_x

Returns the account associated with this record (see FS::svc_acct and FS::svc_broadband).

radius_group

Returns the RADIUS group associated with this record (see FS::radius_group).

SEE ALSO

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