Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/access usergroup"
From Freeside
(import from POD) |
(import from POD) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 18: | Line 18: | ||
</code> | </code> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| − | An FS::access_usergroup object represents an | + | An FS::access_usergroup object represents an internal access user's membership in a group. FS::access_usergroup inherits from FS::Record. The following fields are currently supported: |
; usergroupnum - primary key; usernum -; groupnum - | ; usergroupnum - primary key; usernum -; groupnum - | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
| − | :Creates a new | + | :Creates a new record. To add the record to the database, see [[#insert|"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. | :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. | ||
| Line 33: | Line 33: | ||
:Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. | :Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. | ||
; check | ; check | ||
| − | :Checks all fields to make sure this is a valid | + | :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. |
; access_user; access_group | ; access_user; access_group | ||
==BUGS== | ==BUGS== | ||
Latest revision as of 18:23, 3 October 2007
Contents
NAME
FS::access_usergroup - Object methods for access_usergroup records
SYNOPSIS
use FS::access_usergroup;
$record = new FS::access_usergroup \%hash;
$record = new FS::access_usergroup { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::access_usergroup object represents an internal access user's membership in a group. FS::access_usergroup inherits from FS::Record. The following fields are currently supported:
- usergroupnum - primary key; usernum -; groupnum -
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.
- access_user; access_group
BUGS
The author forgot to customize this manpage.
SEE ALSO
FS::Record, schema.html from the base documentation.
