Как создать модуль Joomla 4.x

Как создать модуль Joomla 4.x
Модуль — это дополнение к сайту, расширяющее функционал. Модуль обычно занимает второстепенную часть веб-страницы и не считается основным элементом страницы.

Он может отображаться на разных позициях, и вы можете выбрать, на каких активных пунктах меню он должен отображаться. Модули — это легкие и гибкие расширения. Они используются для небольших фрагментов страницы, которые, как правило, менее сложны и могут быть видны в разных компонентах.

Часть 1: Структура файла
Есть основные файлы, которые используются в стандартной схеме разработки модулей:

mod_hello.php: этот файл является основной точкой входа для модуля. Он выполняет все необходимые процедуры инициализации, вызывает вспомогательные процедуры для сбора необходимых данных и включает шаблон, который будет отображать выходные данные модуля.

Helper/HelloHelper.php: этот файл содержит вспомогательный класс, который используется для извлечения данных, которые будут отображаться в выводе модуля.

mod_hello.xml: этот файл содержит информацию о модуле. Он определяет файлы, которые должны быть установлены установщиком Joomla, и задает параметры конфигурации для модуля.

tmpl/default.php: это шаблон модуля. Этот файл берет данные, собранные mod_hello.php, и генерирует HTML для отображения на странице.

language/en-GB/en-GB.mod_hello.ini и language/en-GB/en-GB.mod_hello.sys.ini: это файлы, содержащие текст на английском языке Соединенного Королевства.

1. mod_hello.php
Файл mod_hello.php выполняет следующие задачи:

Импортируйте класс ModuleHelper в текущую область. Он понадобится вам позже для отображения вывода.
Импортируйте вспомогательный класс модуля в текущую область в начале файла.
Включите шаблон для отображения вывода.
Вспомогательный класс импортируется в текущую область в начале файла.

используйте Joomla\CMS\Helper\ModuleHelper;
Затем импортируйте вспомогательный класс модуля.

используйте Joomla\Module\Hello\Site\Helper\HelloHelper;
Затем вы включаете шаблон для отображения вывода.

require ModuleHelper::getLayoutPath('mod_hello', $params->get('layout', 'default'));
Завершенный файл mod_hello.php

<?php
/**
* @пакет [ИМЯ ПАКЕТА]
*
* @автор [AUTHOR] <[AUTHOR_EMAIL]>
* @авторское право [АВТОРСКОЕ ПРАВО]
* @license Стандартная общественная лицензия GNU версии 2 или выше; см. ЛИЦЕНЗИЯ.txt
* @ссылка [AUTHOR_URL]
*/

// Нет прямого доступа к этому файлу
определено('_JEXEC') или умереть;

используйте Joomla\CMS\Helper\ModuleHelper;
используйте Joomla\Module\Hello\Site\Helper\HelloHelper;

$test = HelloHelper::getText();

require ModuleHelper::getLayoutPath('mod_hello', $params->get('layout', 'default'));
Первая строка проверяет, подключается ли этот файл из приложения Joomla. Это необходимо для предотвращения внедрения переменных и других потенциальных проблем с безопасностью.

2. Помощник/HelloHelper.php
Вспомогательный класс должен принадлежать пространству имен. Важно, чтобы эта строка находилась в начале файла.

пространство имен Joomla\Module\Hello\Site\Helper;
Затем вы создаете класс с методами.

<?php
/**
* @пакет Joomla.Сайт
* @подпакет mod_hello
*
* @copyright Copyright (C) 2005–2019 Open Source Matters, Inc. Все права защищены.
* @license Стандартная общественная лицензия GNU версии 2 или выше; см. ЛИЦЕНЗИЯ.txt
*/

пространство имен Joomla\Module\Hello\Site\Helper;

// Нет прямого доступа к этому файлу
определено('_JEXEC') или умереть;

класс HelloHelper
{
общедоступная статическая функция getText()
{
вернуть «FooHelpertest»;
}
}

Добавить комментарий