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

Revision as of 20:06, 27 June 2012

NAME

FS::radius_group - Object methods for radius_group records

SYNOPSIS

 use FS::radius_group;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::radius_group object represents a RADIUS group. FS::radius_group inherits from FS::Record. The following fields are currently supported:

groupnum

primary key

groupname

groupname

description

description

priority

priority - for export

METHODS

new HASHREF

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

long_description

Returns a description for this group consisting of its description field, if any, and the RADIUS group name.

radius_attr

Returns all FS::radius_attr objects (check and reply attributes) for this group.

BUGS

This isn't export-specific (i.e. groups are globally unique, as opposed to being unique per-export).

SEE ALSO

FS::radius_usergroup, FS::Record, schema.html from the base documentation.