PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

internal package Foswiki::Prefs::BaseBackend

This is the base module for preferences backends. Its main purpose is to document the interface and provide facilities methods.

ClassMethod new(@_)

Creates a preferences backend object.

ObjectMethod finish()

Break circular references.

ObjectMethod prefs() → @preferenceKeys

Return a list with the names of defined preferences.

ObjectMethod localPrefs() → @preferenceKeys

Return a list with the names of 'Local' preferences.

ObjectMethod get($key) → $value

Return the value of the preference $key.

ObjectMethod getLocal($key) → $value

Return the 'Local' value of the preference $key.

ObjectMethod insert($type, $key, $value ) = @_;

Insert the preference named $key as $value. $type can be 'Local' or 'Set'.

ObjectMethod invalidate($topicObject)

Invalidates the preference backend. This method can be called as an ObjectMethod or a ClassMethod.

ObjectMethod cleanupInsertValue($value_ref)

Utility method that cleans $$vaue_ref for later use in insert().