Pluginentwicklung on markob.de

Das LimeSurvey Plugin-Event-System – eine kritische Betrachtung

Sat, 09 May 2026 00:00:00 +0000

LimeSurvey verfügt über ein event-basiertes Plugin-System. Plugins abonnieren Events, reagieren darauf, und können Daten zurückgeben. Das Konzept ist solide – und weit verbreitet in modernen Frameworks. Die Implementierung erzählt eine andere Geschichte.

Was ein Event-System leisten soll

Ein Event kommuniziert, dass etwas passiert ist oder passieren wird. Der Name beschreibt das Ereignis. Die Parameter sind bekannt und garantiert. Der Empfänger reagiert – er fragt nicht erst nach, ob die Daten überhaupt vorhanden sind.

newDirectRequest – vollständige Webanwendungen im LimeSurvey-Plugin

Sat, 09 May 2026 00:00:00 +0000

Der direct-Event ist der CLI-Einstiegspunkt für LimeSurvey-Plugins. newDirectRequest ist sein HTTP-Pendant: ein Plugin wird über den Browser angesprochen, bekommt einen vollständigen HTTP-Request, und kann eine vollständige HTTP-Response zurückgeben.

Was LimeSurvey dabei nicht mitliefert, ist Routing. Der Event landet im Plugin – was danach passiert, ist vollständig in der Verantwortung des Plugin-Entwicklers.

Wie `newDirectRequest` funktioniert

Die URL, unter der ein Plugin erreichbar ist, folgt diesem Schema:

https://example.com/index.php/plugins/direct/plugin/MeinPlugin

Das Plugin abonniert den Event in init() und prüft das Target – analog zu direct, aber case-insensitiv, da URL-Parameter in der Praxis nicht immer exakt geschrieben werden:

Der direct-Event, gezielter CLI-Einstieg für LimeSurvey-Plugins

Fri, 08 May 2026 00:00:00 +0000

Wenn ein Plugin nicht auf eine Benutzeraktion im Browser reagieren soll, sondern auf der Kommandozeile aufgerufen werden – für einen Cronjob, einen Datenexport, eine nächtliche Bereinigung –, dann ist direct der richtige Einstiegspunkt.

Das Minimalbeispiel

Ein LimeSurvey-Plugin besteht aus mindestens zwei Dateien:

upload/plugins/HelloWorld/
 config.xml
 HelloWorld.php

Der Verzeichnisname, der Klassenname und der <name>-Eintrag in der config.xml müssen identisch sein.

<?xml version="1.0" encoding="UTF-8"?>
<config>
 <metadata>
 <name>HelloWorld</name>
 <type>plugin</type>
 <version>1.0.0</version>
 <author>My Name</author>
 <description><![CDATA[Hello World via CLI]]></description>
 </metadata>
 <compatibility>
 <version>6.0</version>
 <version>5.0</version>
 </compatibility>
</config>

class HelloWorld extends PluginBase
{
 protected $storage = 'LimeSurvey\PluginManager\DbStorage';
 static protected $description = 'HelloWorld';
 static protected $name = 'HelloWorld';

 public function init(): void
 {
 $this->subscribe('direct');
 }

 public function direct(): void
 {
 $event = $this->getEvent();
 if ($event->get('target') !== get_class($this)) {
 return;
 }

 echo 'HELLO WORLD' . PHP_EOL;
 exit;
 }
}

Nach der Aktivierung im Plugin-Manager wird das Plugin so aufgerufen: