TWiki > SetGetPlugin	Daya Bay webs: Public | 中文 | Internal | Help
			Log In or Register

SetGetPlugin

Introduction

Use %SET{}% to store arbitrary text in a named variable, and reuse it with %GET{}% later on within the topic or an included topics. By default, variables live only during topic rendering time, e.g. they do not persist between topic views. It is also possible to remember the variables between topic views, however they are not version controlled like other content in TWiki.

%SET{}% and %GET{}% can be nested inside other TWiki variables and get handled as expected, e.g. inside out, and left to right.

Alternatives to this plugin are:

• TWiki preferences settings: Can be defined on a site level (TWikiPreferences), web level (WebPreferences) and topic level. Preferences settings persist until changed.
• SpreadSheetPlugin variables: Variables can be set with %CALC{$SET(some_name, anything)}% and retrieved with $GET(). These variables persist during page rendering time. A limitation of %CALC{} is that it does not follow the standard TWiki variable evaluation order (nesting inside out, left to right).

Syntax Rules

SET{"name" value="..."} -- set a variable

• Set a named variable that can be retrieved later with %GET{}%. No output is shown, e.g. %SET{}% resolves to an empty string.
• Syntax: %SET{ "name" value="..." remember="1" }%
• Parameters:

  Parameter	Description	Default
  "name"	Name of variable. Alphanumeric characters, dashes and underscores can be used.	(required)
  value="..."	Value of variable. Escape double quotes with backslash.	(required, may be empty)
  remember="1"	If set, the variable will be stored persistently so that it can be used later in any TWiki topic. See important notes.	"0"

• Example: %SET{"lunch" value="Sushi"}%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: GET, IF, SETGETDUMP, SpreadSheetPlugin#FuncSET

Important notes when using the remember option:

• Use descriptive variable names: Keep in mind that the remember option sets a variable with TWiki-global scope, e.g. for all pages and all users. To avoid name clashes, use a descriptive variable name which might include web & topic name and user or group name. For example, instead of variable named "campaign", use a more descriptive name "Marketing-Europe-2024-Campaign".
• Do not store confidential content: The remembered variables are not aware of access control. If a user stores access controlled content in a variable, anyone who knows the variable name or uses the SETGETDUMP variable can read the content.
• Variables are not version controlled, e.g. you do not get the audit trail you have elsewhere in TWiki (topics, attachments, meta data, etc). Consider storing content in TWiki form fields if you need an audit trail.

GET{"name"} -- get a variable

• Get the value of a named variable, previously set with %SET{}%.
• Syntax: %GET{ "name" default="..." }%
• Parameters:

  Parameter	Description	Default
  "name"	Name of variable.	(required)
  format="..."	Format with supported variables: • $name for variable name • $value for variable value • $isdefined expanding to 1 or 0 depending if variable is defined or not • $isset expanding to 1 or 0 depending if variable is logically true or false • $ispersistent expanding to 1 or 0 depending if variable is persistent or not • all FormatTokens such as $dollar, $n, $percnt.	"$value"
  default="..."	Text shown if variable is not defined, e.g. not found. This parameter overrides the format parameter.	"" (empty string)

• Example: %GET{"lunch"}% returns Sushi if the following has been previously set:
  %SET{ "lunch" value="Sushi" }%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: IF, SET, SETGETDUMP, SpreadSheetPlugin#FuncGET

SETGETDUMP{...} -- dump persistent variables

• Dump persistent name/values previously set with %SET{}%.
• Syntax: %SETGETDUMP{ format="..." separator="..." }%
• Parameters:

  Parameter	Description	Default
  format="..."	Format output using variables $name and $value	"name: $name, value: $value <br />"
  separator="..."	String used for separating entries	"\n"

• Example: %SETGETDUMP{"| $name | $value |" separator="$n"}%
• Category: ApplicationsAndComponentsVariables, DevelopmentVariables
• Related: GET, IF, SET, SpreadSheetPlugin#FuncSET

Examples

Set several times

A variable can be set and used several times.

   * Set "demo" to "uno": %SET{ "demo" value="uno" }%
   * Get "demo": %GET{ "demo" }%
   * Set "demo" to "due": %SET{ "demo" value="due" }%
   * Get "demo": %GET{ "demo" }%
   * Set "demo" to "tre": %SET{ "demo" value="tre" }%
   * Get "demo": %GET{ "demo" }%

Search and save result

A SEARCH result can be assigned to a variable for later use. This can be useful for performance reasons if you need the result multiple times. The result can also be post-processed, such as with a $LISTMAP() of the SpreadSheetPlugin.

%SET{
 "result"
 value="%SEARCH{
  "."
  topic="*Skin"
  nonoise="on"
  format="$topic"
  separator=", "
 }%"
}%
   * Result: %GET{result}%
   * Again: %GET{result}%

Last topic view

In a topic, set a variable with the remember flag set that stores the current time. Add also a GET before the SET, it will show the time the topic has last been viewed.

   * Last view: %GET{ "SetGetPlugin-lastview" }%
   * Now: %SET{ "SetGetPlugin-lastview" remember="1" 
      value="%SERVERTIME{$year-$mo-$day $hou:$min:$sec}%"
     }%
     %GET{ "SetGetPlugin-lastview" }%

Remember my mood

This example shows how you can remember the mood of users. The form shows a picklist to select a mood. The mood is stored persistently per user, and shown.

%IF{
 "defined 'mood'"
 then="$percntSET{
  \"SetGetPlugin-mood-%WIKINAME%\" remember=\"1\" 
  value=\"%URLPARAM{mood}%\"
 }$percnt"
}%
My current mood:
  %GET{ "SetGetPlugin-mood-%WIKINAME%" }%
for %WIKIUSERNAME%

<form action="%SCRIPTURL{view}%/%WEB%/%TOPIC%#MyMood">
Change my mood: <select name="mood">
<option>%URLPARAM{mood}%</option>
<option>:-D</option> <option>:-)</option>
<option>:-I</option> <option>:-(</option>
<option>:mad:</option>
</select>
<input type="submit" value="Set" class="twikiSubmit" />
</form>

REST Interface

Variables can also be set and retrieved by invoking a REST (REpresentational State Transfer) request on the TWiki server using the rest script. To persistently remember the state of interactive browser-based JavaScript applications, you can set and get variables using this REST interface via Ajax calls.

The rest script requires authentication, e.g. the user agent is prompted to authenticate if needed.

rest/SetGetPlugin/set -- set a variable

To set a variable call %SCRIPTURL{rest}%/SetGetPlugin/set. It accepts the following URL parameters:

• name - name of variable (required)
• value - value of variable (required, may be empty)
• remember - persistently remember if set to 1 (optional)

Example:
http://dayabay.ihep.ac.cn/twiki/bin/rest/SetGetPlugin/set?name=rest-test;value=This+is+REST;remember=1

rest/SetGetPlugin/get -- get a variable

To get a variable call %SCRIPTURL{rest}%/SetGetPlugin/get. It accepts the following URL parameters:

• name - name of variable (required)
• default - default returned if variable is not found (optional)

Example:
http://dayabay.ihep.ac.cn/twiki/bin/rest/SetGetPlugin/get?name=rest-test;default=rest-test+variable+not+found

Plugin Settings

Show details Hide details

Plugin Installation Instructions

This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details Hide details

Plugin Info

Plugin Author:	TWiki:Main.PeterThoeny
Copyright:	© 2010-2013 TWiki:Main.PeterThoeny © 2010-2013 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public Licen:se )
Plugin Version:	2013-01-28

Show Change History Hide Change History

2013-01-28:	TWikibug:Item7091: Use TWISTY in installation instructions and change history
2012-11-12:	TWikibug:Item7032: GET variable with format parameter
2012-11-12:	TWikibug:Item7020: Categorize TWiki Variable SET, GET, SETGETDUMP
2012-10-11:	TWikibug:Item6978: SetGetPlugin::Core::_savePersistentVar() may fail at Data::Dumper->Dump(). "require Data::Dumper;" line added before that. -- TWiki:Main.HideyoImazu
2012-09-25:	TWikibug:Item6943: Add REST interface
2012-01-06:	TWikibug:Item6828: Removing write to persistent if already exists, and adding data dump -- TWiki:Main.AaronLWalker
2011-07-09:	TWikibug:Item6725: Change global package variables from "use vars" to "our"
2011-04-04:	TWikibug:Item6638: Small doc improvements
2011-03-26:	TWikibug:Item6670: Make variables persistent across topic invocations
2010-10-17:	TWikibug:Item6597: Initial version

TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Benchmarks:	GoodStyle 100%, FormattedSearch 99%, SetGetPlugin 99%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SetGetPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SetGetPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SetGetPluginAppraisal

Related Topics: VarSET, VarGET, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, SpreadSheetPlugin