Make your plugin compatible with LS4/de

Technische Änderungen

Die neue XML-Konfigurationsdatei

Seit LimeSurvey 4.0 benötigen Plugins eine XML-Konfigurationsdatei, um in der Anwendung ausgeführt zu werden.

Der Grund dafür ist die Möglichkeit, Metadateninformationen wie Plugin-Autor, Support-E-Mail-Adresse oder Updater-Informationen zu speichern.

Diese XML-Datei ist in LimeSurvey 4 obligatorisch. Sie sollte sich im Stammverzeichnis des Plugins befinden. Weitere Informationen finden Sie in der Plugin-Entwicklung plugins

Beispiel:

Das neue Plugin-Verzeichnis

Das Plugin-Verzeichnis wurde in LimeSurvey 4 geändert. Aus Sicherheitsgründen befindet sich das Plugin-Verzeichnis aufgrund des neuen Plugin-Managers (Plugin-Uploader) jetzt im Upload-Verzeichnis (/upload/plugins). Bei manuellen Uploads empfehlen wir, Ihre Dateien in das neue Verzeichnis hochzuladen, um Fehlfunktionen der Software zu vermeiden.

Stellen Sie sicher, dass Sie das neue Verzeichnis ändern oder hinzufügen, wenn es in Ihrem Plugin fest codiert ist.

Beispiel:

Die neuen Plugin-Ereignisse

Einige Plugin-Ereignisse von LS3 waren veraltet. Verwenden Sie die in LS4 eingeführten neuen Plugin-Ereignisse, um die alten Plugin-Ereignisse zu ersetzen. Weitere Informationen finden Sie in unserem Entwicklungshandbuch zu plugin events.

Veraltete Funktionen und Methoden

Da sich die Codebasis oder Struktur von LimeSurvey 4 geändert hat, gibt es viele Methoden oder Funktionen, die nicht mehr verwendet werden. Um dieses Problem zu beheben, müssen Sie zuerst den Debug-Modus in der Datei config.php aktivieren und dann zur Plugin-Seite gehen. Jede Methode, die nicht mehr beendet wird, wird auf der Fehlerseite angezeigt.

Einige der Methoden werden in LS4 umbenannt oder nicht mehr verwendet. Um sicherzustellen, dass Ihr Plugin sowohl für LS3 als auch für LS4 funktioniert, überprüfen Sie die Version von LS, bevor Sie die benötigte Methode aufrufen.

Beispiel:

Best Practice

SVG-Dateien vermeiden

For security (XSS) reasons, the upload of SVG Files is not possible. The Plugin uploader will ignore SVG files. Replace them by PNG or JPEG files. The upload of SVG files is possible only if you have access to the installation directory via ftp or other server tools (Upload any files at your own risks).

Avoid global constants

Avoid the use of global constants that can collapse with variables of the core application or other plugins like „ROOT_PATH“. Don‘t use global constant in general for plugin development.

Use Namespaces

Use namespace for better organization by grouping classes that work together to perform a task in your plugin. In that way you avoid using classes that are being used already in the core application.

Example: