Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/access right"

From Freeside
Jump to: navigation, search
(import from POD)
(import from POD)
 
Line 18: Line 18:
 
</code>
 
</code>
 
==DESCRIPTION==
 
==DESCRIPTION==
An FS::access_right object represents an example. FS::access_right inherits from FS::Record. The following fields are currently supported:
+
An FS::access_right object represents a granted access right. FS::access_right inherits from FS::Record. The following fields are currently supported:
  
 
; rightnum - primary key; righttype -; rightobjnum -; rightname -
 
; rightnum - primary key; righttype -; rightobjnum -; rightname -
 
==METHODS==
 
==METHODS==
 
; new HASHREF
 
; new HASHREF
:Creates a new example. To add the example to the database, see [[#insert|"insert"]].
+
:Creates a new right. To add the right 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
+
:Checks all fields to make sure this is a valid right. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
  
 
==BUGS==
 
==BUGS==

Latest revision as of 18:23, 3 October 2007

NAME

FS::access_right - Object methods for access_right records

SYNOPSIS

 use FS::access_right;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::access_right object represents a granted access right. FS::access_right inherits from FS::Record. The following fields are currently supported:

rightnum - primary key; righttype -; rightobjnum -; rightname -

METHODS

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

BUGS

The author forgot to customize this manpage.

SEE ALSO

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