|
|
| Line 1: |
Line 1: |
| − | ==NAME==
| |
| − | FS::access_user_session - Object methods for access_user_session records
| |
| | | | |
| − | ==SYNOPSIS==
| |
| − | <code>
| |
| − | use FS::access_user_session;
| |
| − |
| |
| − | $record = new FS::access_user_session \%hash;
| |
| − | $record = new FS::access_user_session { 'column' => 'value' };
| |
| − |
| |
| − | $error = $record->insert;
| |
| − |
| |
| − | $error = $new_record->replace($old_record);
| |
| − |
| |
| − | $error = $record->delete;
| |
| − |
| |
| − | $error = $record->check;
| |
| − | </code>
| |
| − | ==DESCRIPTION==
| |
| − | An FS::access_user_session object represents a backoffice web session. FS::access_user_session inherits from FS::Record. The following fields are currently supported:
| |
| − |
| |
| − | ; sessionnum
| |
| − | :Database primary key
| |
| − | ; sessionkey
| |
| − | :Session key
| |
| − | ; usernum
| |
| − | :Employee (see [[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]])
| |
| − | ; start_date
| |
| − | :Session start timestamp
| |
| − | ; last_date
| |
| − | :Last session activity timestamp
| |
| − |
| |
| − | ==METHODS==
| |
| − | ; new HASHREF
| |
| − | :Creates a new session. To add the session 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.
| |
| − | ; 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 session. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
| |
| − | ; access_user
| |
| − | :Returns the employee (see [[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]]) for this session.
| |
| − | ; touch_last_date; logout
| |
| − | ==BUGS==
| |
| − | ==SEE ALSO==
| |
| − | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.
| |
