Freeside:4:Documentation:Developer/FS/radius attr

From Freeside
Jump to: navigation, search

NAME

FS::radius_attr - Object methods for radius_attr records

SYNOPSIS

 use FS::radius_attr;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

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

attrnum - primary key; groupnum - FS::radius_group to assign this attribute; attrname - Attribute name, as defined in the RADIUS server's dictionary; value - Attribute value; attrtype - 'C' (check) or 'R' (reply); op - Operator (see http://wiki.freeradius.org/Operators)

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. If any sqlradius-type exports exist and have the export_attrs option enabled, the new attribute will be exported to them.
delete
Delete this record from the database. Like insert, this will delete the attribute from any attached RADIUS databases.
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.
radius_group
Returns the FS::radius_group object to which this attribute applies.

CLASS METHODS

ops ATTRTYPE
Returns a list of all legal values of the "op" field. ATTRTYPE must be C for check or R for reply.

BUGS

SEE ALSO

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