Структура файлів модуля

Весь код, пов’язаний з модулем, зберігається в одному каталозі всередині каталогу modules вашої установки web-інтерфейсу Zabbix (наприклад, zabbix/ui/modules).

Дерево файлів модуля

example_module_directory/ (обов’язково)
          manifest.json (обов’язково) Метадані та визначення дії.
          Module.php Ініціалізація модуля та обробка подій.
          actions/ Файли управління діями.
          SomethingView.php
          SomethingCreate.php
          SomethingDelete.php
          data_export/
          ExportAsXml.php
          ExportAsExcel.php
          views/ view файли.
          example.something.view.php
          example.something.delete.php
          assets/ Будь-які додаткові файли для використання у view. Необхідно вказати в manifest.json.
          js/файли JavaScript, які використовуються у view.
          example.something.view.js.php
          css/ файли CSS, які використовуються у view.
          example.something.css
          image.png Зображення, що використовуються у view.
          example.something.file Будь-який файл для використання у view.

Написання модуля

Приклад процесу написання модуля складається з наступних кроків (там, де це можливо, клацніть на назві файлу або папки, щоб переглянути додаткову інформацію про крок):

  1. Створіть новий каталог для модуля всередині zabbix/ui/modules/.
  2. Додайте файл manifest.json із метаданими модуля.
  3. Створіть папку views та визначте вид(и) модуля.
  4. Створіть папку actions та визначте дії модуля.
  5. Створіть файл Module.php (або Widget.php для віджетів інформаційної панелі) і визначте правила ініціалізації та обробки подій.
  6. Створіть папку assets для файлів JavaScript (розмістіть у assets/js), стилів CSS (розмістіть у assets/css) або будь-яких інших додаткових файлів.
  7. Переконайтеся, що в manifest.json вказані необхідні views, actions та assets.
  8. Зареєструйте модуль у інтерфейсі Zabbix і почніть його використовувати.

Ви можете зареєструвати та ввімкнути модуль, щойно створите файл manifest.json. Після ввімкнення модуля ви можете одразу переглянути всі зміни, внесені до файлів модуля, перезавантаживши інтерфейс Zabbix.