Extension:Semantic Scribunto
| Semantic Scribunto | |
|---|---|
| Provides service functions to support the Scribunto extension | |
| Further Information | |
| Homepage: | follow this link |
| Maintainer(s): | mwjames |
| First released: | 06 2016 |
| Release status: | stable |
| Development status: | active |
| Composer: | mediawiki/semantic-scribunto |
| Area of usage: | |
| Associated with: | SMW |
| Shortcut: This is the shortcut to mark the beginning of the subject line when writing a support request to the mailing list or to the extension's author directly. See also this help page.
|
SSC |
| Table of Contents | |
Contents | |
Documentation can be found in the readme.
mw.smw library functions
The following functions are provided by the mw.smw package.
Overview
Data retrieval functions
Data storage functions
Miscellaneous
Notes
Difference between mw.smw.ask and mw.smw.getQueryResult
Both functions allow you to retrieve data from your smw store. The difference lies in the returned table. Where mw.smw.ask returns a very simplistic result set (its values are all pre-formatted and already type cast), mw.smw.getQueryResult leaves you with full control over your returned data, giving you abundant information but delegates all the data processing to you.
In other words:
- ask is a quick and easy way to get data which is already pre-processed and may not suite your needs entirely.
- getQueryResult gets you the full result set in the same format provided by the api
For more information see the sample results in mw.smw.ask and mw.smw.getQueryResult.
Using #invoke
For a detailed description of the #invoke function, please have a look at the Lua reference manual.
mw.smw library extension
ScribuntoLuaLibrary is the interface for functions that are made available in the mw.smw package and can be extended easily with the expectation that some guidelines are followed to ensure future maintainability and release stability.
- Register the function with ScribuntoLuaLibrary::register
- Isolate the processing and if necessary add an extra class (e.g. LuaAskResultProcessor, LibraryFactory) to separate necessary work steps
- Add tests for PHP and Lua components to ensure that both parts are equally tested and correspond to each other in the expected outcome
- Existing tests should not be altered unless those contain a bug, an unexpected behaviour, or an existing function has changed its behaviour and therefore the expected output
