Plugins - geavanceerd
From LimeSurvey Manual
Overzicht
Sinds versie 2.05 ondersteunt LimeSurvey plugins. Enkele plugins worden door het LimeSurvey-team feitelijk toegevoegd aan LimeSurvey. Andere plugins worden door anderen ondersteund. Je kunt ons vragen om hier een door jou gemaakte plugin te vermelden!
Met een plugin kun je de functionaliteit uitbreiden van LimeSurvey en toch gebruikt blijven maken van onze normale updates.
Deze documentatie is niet bedoeld voor eindgebruikers maar voor ontwerpers die een plugin willen gaan maken voor hun cliënten die LimeSurvey gebruiken.
Plugins moeten de iPlugin interface implementeren. We bevelen aan dat je als basis voor je plugin class de PluginBase class gebruikt.
Plugins maken gebruik van events.
Plugin-instellingen
Door extending gebruik je de voor plugins benodigde functionaliteit die al door ons is gemaakt. Een van de functies is de implementatie van de functie getPluginSettings. Deze functie moet als resultaat een array teruggeven met de configuratie-opties voor de gebruiker.
In het voorbeeld heeft de plugin maar één instelling: message, de te tonen tekst.
protected $settings = array(
'logo' => array(
'type' => 'logo',
'path' => 'assets/logo.png'
),
'message' => array(
'type' => 'string',
'label' => 'Message'
)
);
Het array bevat per instelling een naam als key. Elke waarde is een array met de benodigde metagegevens.
De ondersteunde types:
- logo
- int (integer getal)
- string (alfanumeriek)
- text
- html
- relevance
- info
- password
- date
- select
Naast het type zijn er ook andere keys beschikbaar:
- label, definieert het label
- default, als er geen waarde wordt ingevuld de standaardwaarde (alleen voor algemene instellingen, niet voor enquête-instellingen)
- current, de huidige waarde
- readOnly, toon de instelling als alleen-lezen
- htmlOptions, de htmlOptions van het invoergedeelte ( lees Yii manual [[1]])
- pluginOptions, voor enkele instellingen (html of select) : instelling widget-optie
- labelOptions : htmlOptions van het label
- controlOptions : htmlOptions van de wrapper van label en invoer
Een voorbeeld met alle huidige instellingen.
Lezen en schrijven
Je kunt in de code van de plugin direct de instellingen lezen en schrijven.
Voorbeeld:
$mySetting = $this->get('mySetting');
$this->set('mySetting', $mySetting + 1);
Je kunt een standaardwaarde krijgen als de instelling null is:
$mySetting = $this->get('mySetting', null, null, 10); // 10 is standaardwaarde
Enquête specifieke plug-in instellingen
Er worden twee gebeurtenissen gebruikt om enquêtespecifieke plug-in-instellingen te maken:
- newSurveySettings
- beforeSurveySettings
Voorbeeld om een plug-in uit te schakelen voor een specifieke enquête:
public function init()
{
$this->subscribe('beforeSurveySettings');
$this->subscribe('newSurveySettings');
// Other events...
}
public function beforeSurveySettings()
{
$event = $this->event;
$surveyId = intval($event->get('survey'));
$event->set(
"surveysettings.{$this->id}",
[
'name' => get_class($this),
'settings' => [
'isActive' => [
'type' => 'boolean',
'label' => 'isActive',
'current' => $this->getIsActive($surveyId),
'help' => 'Activate plugin for this survey'
],
]
]
);
}
public function newSurveySettings()
{
$event = $this->event;
foreach ($event->get('settings') as $name => $value)
{
$this->set($name, $value, 'Survey', $event->get('survey'), false);
}
}
private function getIsActive(int $sid): bool
{
return (bool) $this->get('isActive', 'Survey', $sid, false);
}
Events
Een plugin reageert op gebeurtenissen (events) die optreden als de plugin zich daar eerst voor aangemeld (subscribe) heeft. Er is een lijst met de huidige events.
API
Plugins moeten alleen via de eigen LimeSurvey-API extenden. Je moet dus niet rechtstreeks de classes in de source-code aanroepen. Je voorkomt hiermee dat je bij een kleine wijziging aan onze kant zit met een niet meer werkende plugin.
Gebruik zoveel mogelijk deze methodes. Hetzelfde voor de events.
Het API-object is benaderbaar via $this->api bij het extenden van de PluginBase, anders krijg je het via de PluginManager-instantie door de plugin constructor.
Op verzoek kunnen er nieuwe functies aan de API worden toegevoegd.
<span id="Form_extension (New in 6 )">
Formulierextensie (New in 6 )
Introductie
Het systeem 'form extension' is een meer algemene manier om formulieren in de kern van LimeSurvey uit te breiden zonder voor elk formulier een nieuwe gebeurtenis toe te voegen.
Het bestaat uit de volgende componenten:
- Een algemene module genaamd FormExtensionService
- Een bibliotheek van input classes die plug-ins kunnen toevoegen aan bovenstaande module-initialisatie
- Een widget, samen met aangepaste renderers, die worden gebruikt in de LimeSurvey-weergavebestanden
Elk formulier wordt geïdentificeerd door een position string, zoals<form name><dot><tab name> . Voorbeeld: globalsettings.general of globalsettings.security .
Het punt achter een class-based systeem zonder HTML is om de auteurs van plug-ins te bevrijden van het werk om de HTML bij te werken wanneer de kern-HTML verandert. Toch kan de auteur indien nodig het type RawHtmlInput gebruiken.
Een ding dat u in dit systeem niet kunt doen, is het toevoegen van nieuwe tabbladen aan een formulier.
Voorbeeld
Om nieuwe invoer toe te voegen aan een formulier uit een plug-in, gebruikt u de volgende code van uw init() -functie:
OPEN: Opslaan in plug-in-instellingen in plaats van globaal
// Bovenaan bestand
use LimeSurvey\Libraries\FormExtension\Inputs\TextInput;
use LimeSurvey\Libraries\FormExtension\SaveFailedException;
// Inside init()
Yii::app()->formExtensionService->add(
'globalsettings.general',
new TextInput([
'name' => 'myinput',
'label' => 'Label',
'disabled' => true,
'tooltip' => 'Moo moo moo',
'help' => 'Enige helptekst',
'save' => function($request, $connection) {
$value = $request->getPost('myinput');
if ($value === 'een ongeldige waarde') {
throw new SaveFailedException("Kon aangepaste invoer 'myinput'" niet opslaan);
} else {
SettingGlobal::setSetting('myinput', $value);
}
} ,
'load' => function () {
return getGlobalSetting('myinput');
}
])
);
Validatie
Validatie van de invoer gebeurt in de functie save (zie voorbeeld hierboven). Als de geposte waarde ongeldig is, maak dan een SaveFailedException , en er wordt een waarschuwing aan de gebruiker getoond.
Ondersteunde formulieren
De volgende formulieren kunnen worden uitgebreid:
- globalsettings.general (Nieuw in 6.0.0)
Als u ondersteuning voor een ander kernformulier wilt toevoegen, moet u de volgende wijziging toepassen in een pull-request:
Voeg in het weergavebestand toe:
<?php
use LimeSurvey\Libraries\FormExtension\FormExtensionWidget;
use LimeSurvey\Libraries\FormExtension\Inputs\DefaultBaseRenderer;
?>
... meer HTML
<?= FormExtensionWidget::render(
App()-> formExtensionService->getAll('globalsettings.security'),
new DefaultBaseRenderer()
); ?>
Mogelijk moet u een nieuwe class renderer maken op basis van DefaultBaseRenderer , als de formulier-HTML anders is dan andere formulieren. Mogelijk moet u ook de standaard class renderer extenden met invoertypen die nog niet zijn toegevoegd.
De tweede wijziging die u moet doen, is een aanroep toevoegen van de service class voor formulierextensie in de controlleractie die het formulier opslaat:
$request = App()->request;
Yii::app()->formExtensionService->applySave('globalsettings', $request);
Dat is het!
<span id="Localization_ (New in 3 )">
Lokalisatie (Nieuw in 3)
Een plugin kan eigen vertaalbestanden toevoegen. Het gebruikte bestandsformaat is mo, dat is het ook voor LimeSurvey zelf. De bestanden moeten staan in
<plugin root folder>/locale/<language>/<language>.mo
"<language>" staat voor de taalcode, dus voor Nederlands "nl".
Je kunt je vertaalbestand gebruiken met de plugin-functie gT:
$this->gT("A plugin text that needs to be translated");
Als de te vertalen tekst niet in je invoerbestand staat, zoekt de functie in de eigen LimeSurvey vertaalbestanden. Je kunt dus teksten als "Cancel" meestal wel vinden:
$this->gT("Cancel"); // Wordt ook vertaald als "Cancel" niet in het vertaalbestand van de plugin zit.
Als je views gebruikt in je plugin, dan wordt het
$plugin->gT("Translate me");
om de voor de plugin benodigde vertaling in je view te doen.
U kunt het bestand limesurvey.pot gebruiken als voorbeeld voor hoe dit bestand. Dit wordt geïmporteerd in uw vertaaltool.
Tools
Een open-source tool om po- en mo-bestanden te bewerken is Poedit.
<span id="Logging_ (New in 3 )">
Logging (Nieuw in 3)
Als je iets wilt loggen in je plugin, schrijf dan
$this->log("Your message");
Het standaardniveau van loggen is trace, maar je kunt een ander niveau opgeven:
$this->log("Something went wrong!", CLogger::LEVEL_ERROR);
Het logbestand staat in de map
<limesurvey root folder>/tmp/runtime/plugin.log
De naam van de plugin wordt als '''category''' gebruikt. Je kunt op Linux met '''grep''' dan eenvoudig alleen de logging van je eigen plugin zien:
$ tail -f tmp/runtime/plugin.log | grep <your plugin name>
Informatie over [[Optional_settings/nl#Logging instellingen|logging in Yii 1]].
<span id="Extension_updates_{{NewIn|v=4}}"></span>
== Extensie-updates {{NewIn/nl|v = 4}} ==
Sinds LimeSurvey versie 4.0.0 is er een systeem om plug-ins en andere extensie-updates te doen. Als je dit systeem wilt gebruiken, moet je extensiebestand config.xml de updater-configuratie bevatten.
<syntaxhighlight lang="xml">
<updaters>
<updater>
<stable>1</stable>
<type>rest</type>
<source>https://comfortupdate.limesurvey.org/index.php?r=limestorerest</source>
<manualUpdateUrl>https://somedownloadlink.com/maybegithub</manualUpdateUrl>
</updater>
</updaters>
(De broncode hierboven verwijst naar de LimeStore REST API, die wordt gebruikt voor alle extensies die beschikbaar zijn in onze LimeStore.)
| Tag | Beschrijving |
|---|---|
| stable | "1" als deze bron je alleen stabiele versienummers geeft; "0" als de bron ook onstabiele versies zal leveren, zoals 0.3.3-beta.
|
| type | Voorlopig wordt alleen type rest ondersteund. Het is gemakkelijk om nieuwe typen toe te voegen (versiecontroles), zoals git, wget, enz.
|
| source | De URL om nieuwe versies op te halen. |
| manualUpdateUrl | URL waar de gebruiker naar kan gaan om de nieuwste versie van de extensie bij te werken. |
| automaticUpdateUrl | Nog uitwerken |
Als je geen updater wilt aanbieden, moet je de volgende tekst in het XML-configuratiebestand zetten:
<updaters disabled="disabled">
</updaters>
Op deze manier geef je aan dat je het updatesysteem doelbewust hebt uitgeschakeld en niet bent vergeten om het toe te voegen.
De nieuwe plugin UpdateCheck, standaard geïnstalleerd en geactiveerd, controleert maximaal 1 keer per 24 uur asynchroon op nieuwe updates van alle geïnstalleerde extensies wanneer een superbeheerder zich aanmeldt. Als er nieuwe versies worden gevonden, wordt er een melding gepusht.
Als er een nieuwe beveiligingsupdate wordt gevonden, wordt de melding automatisch geopend en weergegeven in de class "danger".
Je kunt ook handmatig controleren op updates door naar de pluginmanager te gaan en op "Updates controleren" te klikken. Deze knop is alleen zichtbaar is als de plugin UpdateCheck actief is.
Onder de motorkap
Dit gedeelte biedt een kort overzicht van de implementatie van de extensie-updater.
De updater is onderdeel van de ExtensionInstaller-bibliotheek. Hieronder ziet u een UML-diagram met de classes die betrekking hebben op het updateproces.
Programmastroom wanneer Yii start:
Yii init
VersionFetcherServiceLocator->init()
Add REST version fetcher
ExtensionUpdaterServiceLocator->init()
Add PluginUpdater
NOG DOEN: Updater toevoegen voor elk type extensie (thema, vraagsjabloon, ...)
Programmastroom tijdens het uitvoeren van de plugin UpdaterCheck:
Download alle updaters van ExtensionUpdaterServiceLocator
Loop elke updater
Voor elke updater doorloop versie-fetchers geconfigureerd door <updater> XML
Neem voor elke fetcher contact op met de externe bron en ontvang versie-informatie
Stel alle versies samen in een boodschap
De methode checkAll in de UpdateCheck-plugin is een voorbeeld van hoe alle extensies naar nieuwe versies kunnen worden verwerkt.
Nieuwe versie-fetchers toevoegen
Als je een nieuwe aangepaste fetcher wilt toevoegen, voer dan dit uit tijdens de Yii-initialisatie:
$service = \Yii::app()->versionFetcherServiceLocator
$service->addVersionFetcherType(
'myNewVersionFetcherType',
function (\SimpleXMLElement $updaterXml) {
return new MyNewVersionFetcher($updaterXml);
}
);
Natuurlijk heeft de class MyNewVersionFetcher de subclass VersionFetcher.
Om een nieuwe fetcher te gebruiken, configureer dan de type tag in de updater-XML
myNewVersionFetcherType (in plaats van bijv. rest ).
Nieuwe extensie-updaters toevoegen
Om een nieuwe extensie-updater toe te voegen, voer dit uit bij de Yii-initialisatie:
$service = \Yii::app()->extensionUpdaterServiceLocator;
$service->addUpdaterType(
'myNewExtensionUpdater',
function () {
return MyNewExtensionUpdater::createUpdaters();
}
);
Class MyNewExtensionUpdater moet een subclass zijn van ExtensionUpdater.
De top type tag in config.xml ( 'plugin', 'thema', ...) zal bepalen welke extensie-updater wordt gebruikt voor deze extensie. Het systeem is nog niet volledig aanpasbaar, omdat je ook een eigen ExtensionInstaller, menu-items, enz. moet toevoegen. Maar in theorie, en misschien in de toekomst, zou het mogelijk moeten zijn om op deze manier een nieuw type extensie toe te voegen.
Extensie-installatieprogramma
De bibliotheek van het installatieprogramma voor extensies bestaat uit twee abstracte klassen:
- ExtensionInstaller
- FileFetcher
De ExtensionInstaller is gesubklasseerd voor elk extensietype, zoals PluginInstaller, QuestionThemeInstaller, enz.
De FileFetcher is gesubklasseerd voor elke verschillende manier om bestanden op te halen. Nu worden alleen geüploade zip-bestanden ondersteund, maar in de toekomst zou er ook een Github- of LimeStore-fetcher kunnen zijn.
Speciale plugins
Beschikbare plugins
Handleiding
In dit voorbeeld tonen we hoe je een plugin maakt die een post request doet bij het afronden van het invullen van de enquête. Je ziet onder meer hoe je globale en enquête-instellingen aanmaakt en bewaard en hoe je events registreert.