NAME

Krang::Pref - Krang Global Preference API

SYNOPSIS

  use Krang::ClassLoader 'Pref';

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

  # get a hash of ids to names for a list preference
  %data = pkg('Pref')->get('contrib_type');

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

  # set a list preference with a list of ids and names
  pkg('Pref')->set(contrib_type => 1 => 'Writer', 2 => 'Photographer');

DESCRIPTION

Krang::Pref 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 supported by Krang::Pref:

• contrib_type (list)
  
List of contributor types, used by Krang::Contrib.
• media_type (list)
  
List of media types, used by Krang::Media.
• search_page_size (scalar)
  
Default search page size, used by Krang::UserPref as a default.

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

INTERFACE

• $opt_id = Krang::Pref->add_option($list_pref_name, $new_pref_opt)
  
Adds a new option to the list of available options for a list preference. The id of the new option is returned.
• $value = Krang::Pref->get('scalar_pref');
  
• %hash = Krang::Pref->get('list_pref');
  
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).

• Krang::Pref->set(scalar_pref => 'value');
  
• Krang::Pref->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.