Зробіть ваш плагін сумісним з LS4

Технічні зміни

Новий конфігураційний файл XML

Починаючи з LimeSurvey 4.0, для запуску плагінів у застосунку потрібен конфігураційний файл XML.

Причина цього — можливість зберігати метадані, такі як автор плагіна, електронна адреса підтримки або інформація про засоби оновлення.

Цей файл XML є обов'язковим у LimeSurvey 4. Він має розташовуватися в кореневому каталозі плагіна. Додаткову інформацію дивіться в розділі розробки плагінів: плагіни

Приклад:

Новий каталог плагінів

У LimeSurvey 4 каталог плагінів змінено. З міркувань безпеки каталог плагінів тепер розташований у каталозі завантажень (/upload/plugins) через новий менеджер плагінів (засіб завантаження плагінів). Для ручного завантаження рекомендуємо завантажувати ваші файли в новий каталог, щоб уникнути збоїв у роботі програмного забезпечення.

Обов'язково змініть або додайте новий каталог, якщо він жорстко прописаний у вашому плагіні.

Приклад:

Нові події плагінів

Деякі події плагінів із LS3 застаріли. Використовуйте нові події плагінів, представлені в LS4, щоб замінити старі. Додаткову інформацію дивіться в нашому посібнику з розробки: події плагінів.

Застарілі функції та методи

Оскільки кодову базу або структуру LimeSurvey 4 змінено, багато методів чи функцій більше не використовуються. Щоб вирішити цю проблему, спочатку потрібно ввімкнути режим налагодження у файлі config.php, а потім перейти на сторінку плагінів. Усі методи, яких більше не існує, буде показано на сторінці помилки.

Деякі методи в LS4 перейменовано або більше не використовуються. Щоб ваш плагін працював і в LS3, і в LS4, перевіряйте версію LS перед викликом потрібного методу.

Приклад:

Найкращі практики

Уникайте файлів SVG

З міркувань безпеки (XSS) завантаження файлів SVG неможливе. Засіб завантаження плагінів ігноруватиме файли SVG. Замініть їх файлами PNG або JPEG. Завантаження файлів SVG можливе лише за наявності доступу до каталогу встановлення через FTP або інші серверні засоби (завантажуйте будь-які файли на власний ризик).

Уникайте глобальних констант

Уникайте використання глобальних констант, які можуть конфліктувати зі змінними основного застосунку або інших плагінів, наприклад „ROOT_PATH“. Загалом не використовуйте глобальні константи під час розробки плагінів.

Використовуйте простори імен

Використовуйте простори імен для кращої організації коду шляхом групування класів, які разом виконують певне завдання у вашому плагіні. Таким чином ви уникнете використання класів, які вже використовуються в основному застосунку.

Приклад: