wiki-archive/twiki/data/TWiki/TWikiPrefsParserDotPm.txt,v

59 lines
1.1 KiB
Plaintext

head 1.1;
access;
symbols;
locks; strict;
comment @# @;
1.1
date 2006.02.01.12.01.25; author TWikiContributor; state Exp;
branches;
next ;
desc
@new-topic
@
1.1
log
@buildrelease
@
text
@---+ Package =TWiki::Prefs::Parser=
This Prefs-internal class is used to parse * Set and * Local statements
from arbitrary text, and extract settings from meta objects. It is used
by TopicPrefs to parse preference settings from topics.
This class does no validation or duplicate-checking on the settings; it
simply returns the recognized settings in the order it sees them in.
%TOC%
---++ ClassMethod *new* <tt>() -> topicparserobject</tt>
Construct a new parser object.
---++ ObjectMethod *parseText* <tt>($text,$prefs)</tt>
Parse settings from text and add them to the preferences in $prefs
---++ ObjectMethod *parseMeta* <tt>($metaObject,$prefs)</tt>
Traverses through all PREFERENCE attributes of the meta object, creating one
setting named with $settingPrefPrefix . 'title' for each. It also
creates an entry named with the field 'name', which is a cleaned-up,
space-removed version of the title.
Settings are added to the $prefs passed.
@