Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/access user pref"
From Freeside
(import from POD) |
(import from POD) |
||
Line 20: | Line 20: | ||
An FS::access_user_pref object represents an per-user preference. Preferenaces are also used to store transient state information (server-side "cookies"). FS::access_user_pref inherits from FS::Record. The following fields are currently supported: | An FS::access_user_pref object represents an per-user preference. Preferenaces are also used to store transient state information (server-side "cookies"). FS::access_user_pref inherits from FS::Record. The following fields are currently supported: | ||
− | ; prefnum - primary key; usernum - Internal access user (see [[Freeside:1.9:Documentation:Developer/FS::access_user|FS | + | ; prefnum - primary key; usernum - Internal access user (see [[Freeside:1.9:Documentation:Developer/FS::access_user|FS/access user]]); prefname -; prefvalue -; expiration - |
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
Line 37: | Line 37: | ||
==BUGS== | ==BUGS== | ||
==SEE ALSO== | ==SEE ALSO== | ||
− | [[Freeside:1.9:Documentation:Developer/FS::access_user]], [[FS::Record|FS | + | [[Freeside:1.9:Documentation:Developer/FS::access_user]], [[FS::Record|FS/access user]], [[FS/Record]], schema.html from the base documentation. |
Revision as of 16:18, 3 October 2007
Contents
NAME
FS::access_user_pref - Object methods for access_user_pref records
SYNOPSIS
use FS::access_user_pref; $record = new FS::access_user_pref \%hash; $record = new FS::access_user_pref { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::access_user_pref object represents an per-user preference. Preferenaces are also used to store transient state information (server-side "cookies"). FS::access_user_pref inherits from FS::Record. The following fields are currently supported:
- prefnum - primary key; usernum - Internal access user (see FS/access user); prefname -; prefvalue -; expiration -
METHODS
- new HASHREF
- Creates a new preference. To add the example to the database, see "insert"|#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.
- 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 preference. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
BUGS
SEE ALSO
Freeside:1.9:Documentation:Developer/FS::access_user, FS/access user, FS/Record, schema.html from the base documentation.