<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::access_user_page_pref

NAME

FS::access_user_page_pref - Object methods for access_user_page_pref records

SYNOPSIS

  use FS::access_user_page_pref;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

DESCRIPTION

An FS::access_user_page_pref object represents a per-page user interface preference. FS::access_user_page_pref inherits from FS::Record. The following fields are currently supported:

prefnum

primary key

usernum

The user who has this preference, a FS::access_user foreign key.

path

The path of the page where the preference is set, relative to the Mason document root.

tablenum

For view and edit pages (which show one record at a time), the record primary key that the preference applies to.

_date

The date the preference was created.

prefname

The name of the preference, as defined by the page.

prefvalue

The value (a free-text field).

METHODS

new HASHREF

Creates a new preference. To add the preference to the database, see "insert".

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.

SEE ALSO

FS::Record

<% include ('/elements/footer.html' ) %>