Plugins - advanced/nl

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
• string
• html
• choice
• relevance
• info

Naast het type zijn er ook andere keys beschikbaar:

• label, definieert het label (gebruik een Engelse tekst, het label wordt later wel vertaald).
• default, als er waarde wordt ingevuld de standaardwaarde.
• current, de huidige waarde.
• readOnly, is het een alleen-lezen instelling.

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

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.

As much as possible interact with LimeSurvey only via methods described here. Same as for 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.

Lokalisatie (nog niet beschikbaar)

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.

Logging (nog niet beschikbaar)

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:

$ tailf tmp/runtime/plugin.log | grep <pluginnaam>

Speciale plugins

• Authentication plugin development
• Export plugin development

Beschikbare plugins

• Authentication plugins
• Audit log
• CintLink
• Available third party 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.