Направете вашия плъгин съвместим с LS4

Технически промени

Новият XML конфигурационен файл

От LimeSurvey 4.0 плъгините се нуждаят от XML конфигурационен файл, за да се изпълняват в приложението.

Причината за това е възможността за съхраняване на информация за метаданни, като автор на плъгин, имейл за поддръжка или информация за актуализатори.

Този XML файл е задължителен в LimeSurvey 4. Той трябва да се намира в основната директория на плъгина. За повече информация проверете разработката на плъгини плъгини

Пример:

Новата директория на добавките

Директорията на приставките е променена в LimeSurvey 4. От съображения за сигурност, директорията на приставките вече се намира в директорията за качване (/upload/plugins) поради новия мениджър на приставките (Plugin uploader). За ръчно качване препоръчваме да качите вашите файлове в новата директория, за да избегнете неправилно функциониране на софтуера.

Не забравяйте да промените или добавите новата директория, ако е твърдо кодирана във вашия плъгин.

Пример:

Новите събития на плъгина

Някои събития на плъгини от LS3 бяха отхвърлени. Използвайте новите събития на приставката, въведени в LS4, за да замените старите събития на приставката. За повече информация вижте нашето ръководство за разработка на събития на приставки.

Отхвърлени функции и методи

Тъй като кодовата база или структурата на LimeSurvey 4 се промениха, има много методи или функции, които вече не се използват. За да коригирате този проблем, първо трябва да активирате режима за отстраняване на грешки във файла config.php и след това да отидете на страницата на приставката. Всеки метод, който вече не излиза, ще бъде показан на страницата за грешка.

Някои от методите са преименувани в LS4 или вече не се използват. За да сте сигурни, че вашият плъгин работи както за LS3, така и за LS4, проверете версията на LS, преди да извикате метода, от който се нуждаете.

Пример:

Най-добра практика

Избягвайте SVG файлове

От съображения за сигурност (XSS) качването на SVG файлове не е възможно. Инструментът за качване на добавки ще игнорира SVG файловете. Заменете ги с PNG или JPEG файлове. Качването на SVG файлове е възможно само ако имате достъп до инсталационната директория чрез ftp или други сървърни инструменти (Качвайте всякакви файлове на свой собствен риск).

Избягвайте глобалните константи

Избягвайте използването на глобални константи, които могат да се свият с променливи на основното приложение или други добавки като „ROOT_PATH“. Не използвайте глобална константа като цяло за разработка на плъгини.

Използвайте пространства от имена

Използвайте пространство от имена за по-добра организация чрез групиране на класове, които работят заедно, за да изпълнят задача във вашия плъгин. По този начин избягвате използването на класове, които вече се използват в основното приложение.

Пример: