Як створити свій модуль в Joomla

Структура модулів Joomla 6. Яка роль файлів в модулях. Як зробити клон існуючого модуля з своїми функціями.

У Joomla є два основних шляхи розв'язання цієї задачі, залежно від того, наскільки глибокі зміни ти плануєш внести. Якщо потрібно додати нові можливості (логіку), а не просто змінити вигляд, тобі найкраще підійде створення клону існуючого модуля.

Спосіб 1: Створення власного модуля на базі існуючого (Клонування)

Це повна копія модуля, наприклад mod_articles_news або mod_articles_category, яка буде жити своїм життям і не залежатиме від оновлень системи. Якщо редагувати існуючий, оновлення системи може стерти твої зміни.

Кроки для реалізації:

  1. Копіювання папки: Зайди в /modules/ і скопіюй папку потрібного модуля (наприклад, mod_articles_category) у нову папку з твоєю назвою, наприклад mod_new_articles.
  2. Перейменування файлів: Усередині нової папки перейменуй основні файли:
    • mod_articles_news.xml → mod_new_articles.xml
    • mod_articles_news.php → mod_new_articles.php (якщо він є, не всі модулі його мають)
  3. Редагування XML-файлу (найважливіше): Відкрий .xml файл і зміни метадані, щоб Joomla зрозуміла, що це новий модуль:
    • <name>mod_new_articles</name> — технічна назва.
    • <namespace>MyCompany\Module\MyArticles</namespace> — пропиши свій простір імен (що означає namespace).
    • Зміни опис <description>, щоб ти бачив різницю в адмінці.
  4. Коригування PHP-файлу: Відкрий головний .php файл модуля (якщо він є). Коли там використовуються класи або хелпери, переконайся, що шлях до них відповідає твоєму новому namespace.
  5. Встановлення: Зайди в адмінку: System -> Install -> Discover. Натисни "Discover", вибери свій новий модуль і натисни "Install". Тепер у тебе є власний незалежний модуль.

Структура модулів joomla

Перехід на сучасну архітектуру Joomla 6 з використанням Namespace та WebAssetManager — це рівень професійної розробки.

Dependency Injection (Впровадження залежностей).

Ось роль кожного файлу в цій "машині":

1. services/provider.php (Реєстратор)

Це "свідоцтво про народження" твого модуля для системи.

  • Роль: Він реєструє твій модуль у сервіс-контейнері Joomla.
  • Як працює: Коли Joomla завантажується, вона сканує папку services. Цей файл каже системі: «Якщо комусь знадобиться модуль mod_new_articles, ось інструкція, як створити його екземпляр».
  • Що там відбувається: Він зв'язує твій Dispatcher (про який нижче) з ядром Joomla. Без цього файлу Joomla просто не побачить твій модуль, навіть якщо файли фізично існують.

2. src/Dispatcher/Dispatcher.php (Диспетчер/Контролер)

Це "мозок" модуля. У нових версіях Joomla він замінює собою частину логіки, яка раніше була просто в .php файлі в корені модуля (інколи і всю логіку).

  • Роль: Він керує процесом відображення. Його головна задача — зібрати дані та передати їх у шаблон (layout).
  • Як працює: Метод getLayoutData() всередині цього файлу збирає масив даних. Наприклад, він викликає Helper, отримує список картинок з папки чи матеріалів та повертає їх. Потім ці дані стають доступними у файлі default.php (твого шаблону) через змінну $displayData.

3. src/Helper/Helper.php (Помічник/Логіка)

Це "робочі руки" модуля.

  • Роль: Тут виконується "брудна" робота: робота х БД, сканування папок на диску, перевірка розширень файлів (.jpg, .png, .svg) та формування масиву результатів.
  • Як працює: Dispatcher звертається до Helper, просить: «Дай мені список картинок з папки images/gallery або список матеріалів з БД». Хелпер виконує це завдання і повертає готовий список. Це дозволяє тримати код чистим: логіка обробки даних окремо, а логіка відображення — окремо.

mod_new_articles.php (Точка входу)

У Joomla 6 цей файл став дуже коротким.

  • Роль: Він просто ініціалізує Диспетчер.
  • Код зазвичай виглядає так:
\defined('_JEXEC') or die;
use Useit\Module\Usegall\Site\Dispatcher\Dispatcher;
// Виклик диспетчера, який запустить весь процес
$dispatcher = $container->get(Dispatcher::class);
$dispatcher->dispatch();

Підсумок: Як файли модуля працюють разом (Ланцюжок)

  1. Joomla бачить модуль на сторінці й звертається до Provider, щоб дізнатися, як його запустити.
  2. Provider реєструє Dispatcher.
  3. Dispatcher викликає Helper, щоб отримати список матеріалів з БД чи зображень із папки (залежно від функції модуля).
  4. Helper сканує папку, фільтрує файли й повертає масив матеріалів чи картинок Диспетчеру.
  5. Dispatcher бере цей масив і "віддає" його файлу tmpl/default.php.
  6. default.php (шаблон) просто виводить ці масив в циклі foreach.

Спосіб 2: Layout Override (якщо зміни лише у вигдяді)

Якщо логіка вибору статей (категорії, фільтри) тебе влаштовує, але ти хочеш додати нові поля в дизайн (наприклад, ціну або іконку), краще використати перевизначення (Override). Це стандартний механізм Joomla, який не затирається при оновленнях.

Як це зробити:

  1. Зайди в System -> Site Templates.
  2. Натисни на назву свого шаблону.
  3. Перейди на вкладку Create Overrides.
  4. Знайди в списку mod_articles_news (або той, що ти вибрав) і натисни на нього.
  5. Joomla створить копію файлів виводу в папку: templates/твій_шаблон/html/mod_articles_news/

Тепер ти можеш редагувати ці файли як завгодно. Навіть при оновленні самої Joomla, твої файли в папці шаблону залишаться недоторканими.

Що вибрати для сайту?

  • Вибирай Клонування (Спосіб 1), якщо ти хочеш додати нові поля в налаштування модуля (наприклад, вибір матеріалів, специфічні фільтри по ціні, які не передбачені в стандарті).
  • Вибирай Override (Спосіб 2), якщо тобі просто потрібно, щоб список статей виглядав як картки з цінами та кнопками "Замовити".

Порада щодо нових можливостей:

Якщо ти обереш Спосіб 1, зверни увагу на файл src/Helper/ArticlesHelper.php (якщо він є в структурі). Саме там зазвичай пишеться запит до бази даних (SQL), якщо тобі потрібно витягнути якісь додаткові дані, яких немає в стандартних статтях.