Difference: TWikiPrefsDotPm (1 vs. 7)

Revision 72010-05-29 - TWikiContributor

Line: 30 to 30

Changed:
< <	ObjectMethod pushPreferences `($web,$topic,$type)`
> >	ObjectMethod pushPreferences `($web,$topic,$type,$prefix)`
	`$web` - web to read from `$topic` - topic to read `$type` - DEFAULT, SITE, USER, SESSION, WEB, TOPIC or PLUGIN

Revision 62008-01-22 - TWikiContributor

Line: 25 to 25

Changed:
< <	ObjectMethod finish Complete processing after the client's HTTP request has been responded to. breaking circular references to allow garbage collection in persistent environments
> >	ObjectMethod finish `()` Break circular references.

Line: 67 to 64

Changed:
< <	ObjectMethod resetTo `($mark)`
> >	ObjectMethod restore `($mark)`
	Resets the preferences stack to the given mark, to recover after a topic include.
Line: 114 to 111

Added:
> >	setPreferencesValue($name, $val) Set a preferences value. The preference is set in the context at the top of the preference stack, whatever the current state may be. The preference is not serialised.
	ObjectMethod stringify() -> $text Generate a TML-formatted version of the current preferences

Revision 52007-01-16 - TWikiContributor

Line: 33 to 33

Deleted:
< <	ObjectMethod pushGlobalPreferences `()` Add global preferences to this preferences stack.
	ObjectMethod pushPreferences `($web,$topic,$type)` `$web` - web to read from `$topic` - topic to read
Line: 55 to 50

Added:
> >	ObjectMethod pushGlobalPreferences `()` Add global preferences to this preferences stack.
	ObjectMethod pushPreferencesValues `($type,\%values)` Push a new preference level using type and values given

Revision 42006-10-25 - TWikiContributor

Line: 98 to 98

Changed:
< <	getTextPreferencesValue( $key, $text, $web, $topic ) -> $value Get a preference value from the settings in the text. The values are not cached.
> >	getTextPreferencesValue( $key, $text, $meta, $web, $topic ) -> $value Get a preference value from the settings in the text (and/or optional $meta). The values read are not cached.
	ObjectMethod getWebPreferencesValue `($key,$web) -> $value`

Revision 32006-06-25 - TWikiContributor

Line: 25 to 25

Added:
> >	ObjectMethod finish Complete processing after the client's HTTP request has been responded to. breaking circular references to allow garbage collection in persistent environments
	ObjectMethod pushGlobalPreferences `()` Add global preferences to this preferences stack.

Revision 22006-04-01 - TWikiContributor

Line: 91 to 91
	getTextPreferencesValue( $key, $text, $web, $topic ) -> $value
Changed:
< <	Get a preference value from the settings in the text. The parsed values are cached against the web, topic.
> >	Get a preference value from the settings in the text. The values are not cached.
	ObjectMethod getWebPreferencesValue `($key,$web) -> $value`

Revision 12006-02-01 - TWikiContributor

Line: 1 to 1

Line: 1 to 1
Added:
> >	Package `TWiki::Prefs` The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences for global, web, user and topic contexts, and provides the means to look up preferences in these. Preferences from different places stack on top of each other, so there are global preferences, then site, then web (and subweb and subsubweb), then topic, included topic and so on. Each level of the stack is tagged with a type identifier. The module also maintains a separate of the preferences found in every topic and web it reads. This supports the lookup of preferences for webs and topics that are not on the stack, and must not be chained in (you can't allow a user to override protections from their home topic!) On this page: ClassMethod new `($session[,$cache])` ObjectMethod finish `()` ObjectMethod pushPreferences `($web,$topic,$type,$prefix)` ObjectMethod pushWebPreferences `($web)` ObjectMethod pushGlobalPreferences `()` ObjectMethod pushPreferencesValues `($type,\%values)` ObjectMethod mark `()` ObjectMethod restore `($mark)` ObjectMethod getPreferencesValue `($key) -> $value` ObjectMethod isFinalised `($key)` ObjectMethod getTopicPreferencesValue `($key,$web,$topic) -> $value` getTextPreferencesValue( $key, $text, $meta, $web, $topic ) -> $value ObjectMethod getWebPreferencesValue `($key,$web) -> $value` setPreferencesValue($name, $val) ObjectMethod stringify() -> $text ClassMethod new `($session[,$cache])` Creates a new Prefs object. If $cache is defined, it will be pushed onto the stack. ObjectMethod pushGlobalPreferences `()` Add global preferences to this preferences stack. ObjectMethod pushPreferences `($web,$topic,$type)` `$web` - web to read from `$topic` - topic to read `$type` - DEFAULT, SITE, USER, SESSION, WEB, TOPIC or PLUGIN `$prefix` - key prefix for all preferences (used for plugins) Reads preferences from the given topic, and pushes them onto the preferences stack. ObjectMethod pushWebPreferences `($web)` Pushes web preferences. Web preferences for a particular web depend on the preferences of all containing webs. ObjectMethod pushPreferencesValues `($type,\%values)` Push a new preference level using type and values given ObjectMethod mark `()` Return a marker representing the current top of the preferences stack. Used to remember the stack when new web and topic preferences are pushed during a topic include. ObjectMethod resetTo `($mark)` Resets the preferences stack to the given mark, to recover after a topic include. ObjectMethod getPreferencesValue `($key) -> $value` =$key - key to look up Returns the value of the preference `$key`, or undef. Looks up local preferences when the level topic is the same as the current web,topic in the session. ObjectMethod isFinalised `($key)` Return true if $key is finalised somewhere in the prefs stack ObjectMethod getTopicPreferencesValue `($key,$web,$topic) -> $value` Recover a preferences value that is defined in a specific topic. Does not recover web, user or global settings. Intended for use in protections mechanisms, where the order doesn't match the prefs stack. getTextPreferencesValue( $key, $text, $web, $topic ) -> $value Get a preference value from the settings in the text. The parsed values are cached against the web, topic. ObjectMethod getWebPreferencesValue `($key,$web) -> $value` Recover a preferences value that is defined in the webhome topic of a specific web.. Does not recover user or global settings, but does recover settings from containing webs. Intended for use in protections mechanisms, where the order doesn't match the prefs stack. ObjectMethod stringify() -> $text Generate a TML-formatted version of the current preferences

Added:

>
>

Package `TWiki::Prefs`

The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences for global, web, user and topic contexts, and provides the means to look up preferences in these.

Preferences from different places stack on top of each other, so there are global preferences, then site, then web (and subweb and subsubweb), then topic, included topic and so on. Each level of the stack is tagged with a type identifier.

The module also maintains a separate of the preferences found in every topic and web it reads. This supports the lookup of preferences for webs and topics that are not on the stack, and must not be chained in (you can't allow a user to override protections from their home topic!)

On this page:

ClassMethod new ($session[,$cache])
ObjectMethod finish ()
ObjectMethod pushPreferences ($web,$topic,$type,$prefix)
ObjectMethod pushWebPreferences ($web)
ObjectMethod pushGlobalPreferences ()
ObjectMethod pushPreferencesValues ($type,\%values)
ObjectMethod mark ()
ObjectMethod restore ($mark)
ObjectMethod getPreferencesValue ($key) -> $value
ObjectMethod isFinalised ($key)
ObjectMethod getTopicPreferencesValue ($key,$web,$topic) -> $value
getTextPreferencesValue( $key, $text, $meta, $web, $topic ) -> $value
ObjectMethod getWebPreferencesValue ($key,$web) -> $value
- setPreferencesValue($name, $val)
ObjectMethod stringify() -> $text

ClassMethod new `($session[,$cache])`

Creates a new Prefs object. If $cache is defined, it will be pushed onto the stack.

ObjectMethod pushGlobalPreferences `()`

Add global preferences to this preferences stack.

ObjectMethod pushPreferences `($web,$topic,$type)`

$web - web to read from
$topic - topic to read
$type - DEFAULT, SITE, USER, SESSION, WEB, TOPIC or PLUGIN
$prefix - key prefix for all preferences (used for plugins)

Reads preferences from the given topic, and pushes them onto the preferences stack.

ObjectMethod pushWebPreferences `($web)`

Pushes web preferences. Web preferences for a particular web depend on the preferences of all containing webs.

ObjectMethod pushPreferencesValues `($type,\%values)`

Push a new preference level using type and values given

ObjectMethod mark `()`

Return a marker representing the current top of the preferences stack. Used to remember the stack when new web and topic preferences are pushed during a topic include.

ObjectMethod resetTo `($mark)`

Resets the preferences stack to the given mark, to recover after a topic include.

ObjectMethod getPreferencesValue `($key) -> $value`

=$key - key to look up

Returns the value of the preference $key, or undef.

Looks up local preferences when the level topic is the same as the current web,topic in the session.

ObjectMethod isFinalised `($key)`

Return true if $key is finalised somewhere in the prefs stack

ObjectMethod getTopicPreferencesValue `($key,$web,$topic) -> $value`

Recover a preferences value that is defined in a specific topic. Does not recover web, user or global settings.

Intended for use in protections mechanisms, where the order doesn't match the prefs stack.

getTextPreferencesValue( $key, $text, $web, $topic ) -> $value

Get a preference value from the settings in the text. The parsed values are cached against the web, topic.

ObjectMethod getWebPreferencesValue `($key,$web) -> $value`

Recover a preferences value that is defined in the webhome topic of a specific web.. Does not recover user or global settings, but does recover settings from containing webs.

Intended for use in protections mechanisms, where the order doesn't match the prefs stack.

ObjectMethod stringify() -> $text

Generate a TML-formatted version of the current preferences

View topic | History: r7 < r6 < r5 < r4 | More topic actions...

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding ARC TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiPrefsDotPm.

Difference: TWikiPrefsDotPm (1 vs. 7)

Revision 72010-05-29 - TWikiContributor

ObjectMethod pushPreferences ($web,$topic,$type)

ObjectMethod pushPreferences ($web,$topic,$type,$prefix)

Revision 62008-01-22 - TWikiContributor

ObjectMethod finish

ObjectMethod finish ()

ObjectMethod resetTo ($mark)

ObjectMethod restore ($mark)

setPreferencesValue($name, $val)

ObjectMethod stringify() -> $text

Revision 52007-01-16 - TWikiContributor

ObjectMethod pushGlobalPreferences ()

ObjectMethod pushPreferences ($web,$topic,$type)

ObjectMethod pushGlobalPreferences ()

ObjectMethod pushPreferencesValues ($type,\%values)

Revision 42006-10-25 - TWikiContributor

getTextPreferencesValue( $key, $text, $web, $topic ) -> $value

getTextPreferencesValue( $key, $text, $meta, $web, $topic ) -> $value

ObjectMethod getWebPreferencesValue ($key,$web) -> $value

Revision 32006-06-25 - TWikiContributor

ObjectMethod finish

ObjectMethod pushGlobalPreferences ()

Revision 22006-04-01 - TWikiContributor

getTextPreferencesValue( $key, $text, $web, $topic ) -> $value

ObjectMethod getWebPreferencesValue ($key,$web) -> $value

Revision 12006-02-01 - TWikiContributor

Package TWiki::Prefs

ClassMethod new ($session[,$cache])

ObjectMethod pushGlobalPreferences ()

ObjectMethod pushPreferences ($web,$topic,$type)

ObjectMethod pushWebPreferences ($web)

ObjectMethod pushPreferencesValues ($type,\%values)

ObjectMethod mark ()

ObjectMethod resetTo ($mark)

ObjectMethod getPreferencesValue ($key) -> $value

ObjectMethod isFinalised ($key)

ObjectMethod getTopicPreferencesValue ($key,$web,$topic) -> $value

getTextPreferencesValue( $key, $text, $web, $topic ) -> $value

ObjectMethod getWebPreferencesValue ($key,$web) -> $value

ObjectMethod stringify() -> $text

ObjectMethod pushPreferences `($web,$topic,$type)`

ObjectMethod pushPreferences `($web,$topic,$type,$prefix)`

ObjectMethod finish `()`

ObjectMethod resetTo `($mark)`

ObjectMethod restore `($mark)`

ObjectMethod pushGlobalPreferences `()`

ObjectMethod pushPreferences `($web,$topic,$type)`

ObjectMethod pushGlobalPreferences `()`

ObjectMethod pushPreferencesValues `($type,\%values)`

ObjectMethod getWebPreferencesValue `($key,$web) -> $value`

ObjectMethod pushGlobalPreferences `()`

ObjectMethod getWebPreferencesValue `($key,$web) -> $value`

Package `TWiki::Prefs`

ClassMethod new `($session[,$cache])`

ObjectMethod pushGlobalPreferences `()`

ObjectMethod pushPreferences `($web,$topic,$type)`

ObjectMethod pushWebPreferences `($web)`

ObjectMethod pushPreferencesValues `($type,\%values)`

ObjectMethod mark `()`

ObjectMethod resetTo `($mark)`

ObjectMethod getPreferencesValue `($key) -> $value`

ObjectMethod isFinalised `($key)`

ObjectMethod getTopicPreferencesValue `($key,$web,$topic) -> $value`

ObjectMethod getWebPreferencesValue `($key,$web) -> $value`