Создание "Hello World" Модуль для Joomla! 1.5
Модуль представляет собой легкий и гибкий Расширение, которое используется для визуализации страницы. Они используются для преобразования страницу, которая, как правило, менее сложными и могут рассматриваться в различных компонентов.
Вы можете видеть много примеров из модулей в стандартной Joomla! установить: - меню - Последние новости - Войти форме - и многое другое.
Этот учебник будет объяснить, как идти о создании простой Hello World модуль. С помощью этого учебника вы узнаете основные структуры файла модуля. Это основная структура может быть расширена для получения более сложных модулей.
Структура файла
Существуют четыре основные файлы, которые используются в стандартную схему разработки модулей:
-
mod_helloworld.php Этот файл является основной точкой входа для модуля. Она будет выполнять все необходимые процедуры инициализации вызова вспомогательные процедуры для сбора необходимых данных, и включают в себя шаблон, в котором будет отображаться модуль вывода.
-
mod_helloworld.xml Этот файл содержит информацию о модуле. Он определяет файлы, которые должны быть установлены по Joomla! установки и задает параметры конфигурации для модуля.
-
helper.php Этот файл содержит вспомогательный класс, который используется для выполнения фактической работы в получении информации, которая будет отображаться в модуле (как правило, из базы данных или другого источника).
-
tmpl/default.php это шаблон модуля. Этот файл будет принимать данные, собранные mod_helloworld.php и генерировать HTML, который будет отображаться на странице.
Создание mod_helloworld.php
Mod_helloworld.php файл будет выполнять три задачи:
* Включают helper.php файл, который содержит класса, которые будут использоваться для сбора необходимых данных
* Вызвать соответствующий метод вспомогательный класс для получения данных
* Включает шаблон для отображения вывода.
Вспомогательный класс определяется в нашей helper.php файл. Этот файл входит в состав require_once заявление:
require_once( dirname(__FILE__).DS.'helper.php' );
require_once используется, потому что наши вспомогательные функции определены в классе, и мы хотим определить класс один раз.
Наши вспомогательный класс не был определен еще нет, но когда оно есть, оно будет содержать один метод: getHello (). Для нашей простой пример, это на самом деле не нужно делать этого - "Hello, World" сообщение, что этот метод возвращает может быть просто включен в шаблон. Мы используем вспомогательный класс здесь, чтобы продемонстрировать это основной метод.
Наш модуль в настоящее время не использует каких-либо параметров, но мы будем передавать их вспомогательным методом, в любом случае так, что он может быть использован позже, если мы решили расширить функциональность нашего модуля.
Вспомогательный метод класса вызывается следующим образом:
$hello = modHelloWorldHelper::getHello( $params );
Завершено mod_helloworld.php файл
Полный файл mod_helloworld.php выглядит следующим образом:
<?php
/**
* Hello World! Module Entry Point
*
* @package Joomla.Tutorials
* @subpackage Modules
* @link http://dev.joomla.org/component/option,com_jd-wiki/Itemid,31/id,tutorials:modules/
* @license GNU/GPL, see LICENSE.php
* mod_helloworld is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*/
// не имеет прямого доступа
defined( '_JEXEC' ) or die( 'Restricted access' );
// Включить функции синдиката только один раз
require_once( dirname(__FILE__).DS.'helper.php' );
$hello = modHelloWorldHelper::getHello( $params );
require( JModuleHelper::getLayoutPath( 'mod_helloworld' ) );
?>
Одной линии, что мы не объяснили до сих пор является первой линией. Эта линия проверки, чтобы убедиться, что данный файл является включением из Joomla! приложения. Это необходимо для предотвращения переменной инъекций и других потенциальных проблем в области безопасности.
Создание helper.php
Helper.php, что файл содержит вспомогательный класс, который используется для получения данных, которые будут отображаться в модуль вывода. Как отмечалось ранее, наш вспомогательный класс будет иметь один метод: getHello (). Этот метод будет возвращать "Hello, World" сообщения.
Вот код для helper.php файл:
<?php
/**
* Helper class for Hello World! module
*
* @package Joomla.Tutorials
* @subpackage Modules
* @link http://dev.joomla.org/component/option,com_jd-wiki/Itemid,31/id,tutorials:modules/
* @license GNU/GPL, see LICENSE.php
* mod_helloworld is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*/
class modHelloWorldHelper
{
/**
* Retrieves the hello message
*
* @param array $params An object containing the module parameters
* @access public
*/
function getHello( $params )
{
return 'Hello, World!';
}
}
?>
Существует нет правила о том, что мы должны назвать наш вспомогательный класс, как у нас, но это полезно сделать так, чтобы это было легко идентифицировать и locateable.
Более продвинутые модули могут включать в себя запросы к базе данных или других функциональных вспомогательный метод класса.
Создание TMPL / default.php
Default.php файл шаблона, который отображает модуль вывода.
Код для default.php файл выглядит следующим образом:
<?php // не имеет прямого доступа
defined( '_JEXEC' ) or die( 'Restricted access' ); ?>
<?php echo $hello; ?>
Важно отметить, что шаблон имеет тех же пределах, mod_helloworld.php файл. Что это означает, что переменная $ привет может быть определена в mod_helloworld.php файл, а затем использовать в $ привет файл без каких-либо дополнительных заявлений или вызовы функций.
Создание mod_helloworld.xml
Mod_helloworld.xml используется для определения, какие файлы установки необходимо скопировать и используется модуль Manager, чтобы определить, какие параметры используются для настройки модуля. Другая информация о модуле также указано в этом файле.
Код для mod_helloworld.xml выглядит следующим образом:
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">
<name>Hello, World!</name>
<author>John Doe</author>
<version>1.5.0</version>
<description>A simple Hello, World! module.</description>
<files>
<filename>mod_helloworld.xml</filename>
<filename module="mod_helloworld">mod_helloworld.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>
<params>
</params>
</install>
Вы заметите, что Существуют две дополнительные файлы, которые мы еще не упоминалось: index.html и TMPL / index.html. Эти файлы включены так, что эти каталоги не могут быть просмотрены. Если пользователь пытается указать свой браузер в эти папки, файла index.html будет отображаться. Эти файлы могут быть пустым или может содержать простые строки:
<html><body bgcolor="#FFFFFF"></body></html>
который будет отображать пустую страницу.
Так как наш модуль не использует никаких параметров, то этот раздел пуст.
Заключение
Разработка модулей для Joomla! является достаточно простой, простой процесс. Использование методов, описанных в этом учебнике, бесконечное разнообразие модули могут быть разработаны с мало хлопот.
