MediaWiki extensions manual
VariablesLua
Release status: beta
Implementation Parser extension
Description Provides support for the Variables extension in Lua modules by the Scribunto extension
Author(s) Alex Winkler
Latest version 1.5.0 (2021-11-23)
MediaWiki 1.35+
License MIT License
Download

GitHub:

Note:
No localisation updates are
provided by translatewiki.net .
Hooks used
  • ScribuntoExternalLibraries

The VariablesLua extension provides support for the Variables extension in Lua modules by the Scribunto extension.

Bugs and Feature Requests
Issues at GitHub

Usage

Manual: Liquipedia Help

The extension can be loaded in Lua modules by the Scribunto extension like this:

VariablesLua = mw.ext.VariablesLua

Functions

Functions are based on the ones provided by the Variables extension, adding some more utility.

VariablesLua.vardefine

See also: Extension:Variables##vardefine

VariablesLua.vardefine( name, value )

Stores the given value under the given name. If the value is nil, an empty string is stored.

VariablesLua.vardefineecho

See also: Extension:Variables##vardefineecho

VariablesLua.vardefineecho( name, value )

Identical to VariablesLua.vardefine, but returns the value after storing it.

VariablesLua.var

See also: Extension:Variables##var

VariablesLua.var( name, default )

Retrieve a variable stored under the given name.

VariablesLua.varexists

See also: Extension:Variables##varexists

VariablesLua.varexists( name )

Checks if a variable exists. Returns a boolean value.

VariablesLua.var_final

See also: Extension:Variables##var_final

VariablesLua.var_final( name, default )

Returns the last value stored (i.e. the last VariablesLua.vardefine or #vardefine in the code). The value can only be returned and not be used in the Lua code itself.

Installation

  • Make sure the Variables extension and Scribunto extension are installed.
  • Download and place the file(s) in a directory called VariablesLua in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file: 
    wfLoadExtension( 'VariablesLua' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Version history

1.0.0
  • Initial release.
1.1.0
1.2.0
  • Added argument type checking.
1.2.1
  • Bug fixes.
1.3.0
  • Added mw.ext.VariablesLua.var_table().
1.4.0
  • Removed mw.ext.VariablesLua.var_table() due to changes in Extension:Variables.
1.4.1
  • Some minor updates, nothing security relevant but can potentially avoid weird edgecases.
1.4.2
  • Renamed some functions and classes to be in line with the MediaWiki styleguide.
1.5.0
  • Restored the boolean return value of mw.ext.VariablesLua.varexists().

See also

This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.