NAME

Krang::MyPref - Krang user preference API

SYNOPSIS

  use Krang::ClassLoader 'MyPref';

  # get the value set 'search_page_size', a scalar preference
  $page_size = pkg('MyPref')->get('search_page_size');

  # set a scalar preference
  pkg('MyPref')->set(search_page_size => 10);

DESCRIPTION

Krang::MyPref provides a means for the user to access and change configurable settings.

There are two types of Preferences: scalars and lists. A scalar preference accepts a single value. A list preference contains a list of values, identified by unique IDs mapping to names.

The following preferenes are currently supported by Krang::MyPref:

• search_page_size (scalar)
  
Default search page size.

New preferences can be added by editing the configuration data in this module.

INTERFACE

• $value = Krang::MyPref->get('scalar_pref');
  
• $value = Krang::MyPref->get('scalar_pref', $user_id);
  
• %hash = Krang::MyPref->get('list_pref');
  
• %hash = Krang::MyPref->get('list_pref', $user_id);
  
Gets the data configured for a given preference. For scalar preferences, returns the configured value. For list preferences, returns a hash mapping IDs to names.

If no value has been configured for the preference then nothing is returned (undef in scalar context, empty list in list context).

The second argument '$user_id' is optional. If not specified, this method will return the preference(s) of the logged-in user.

• Krang::MyPref->set(scalar_pref => 'value');
  
• Krang::MyPref->set(list_pref => 1 => ``value1'', 2 => ``value2'');
  
Sets a preference to a given value. For scalar preferences, takes a single value. For list preferences, takes a list a IDs and corresponding names.

Note that this method does not do any dependency checking on values being removed from the table.