Создание и редактирование модулей Limbo

Введение
Создание модулей для Limbo легкое и простое занятие, в некоторой степени похожее на создание модуля для мамбо. Пожалуйста, следуйте этому руководству, создавая модуль для Limbo.

Эта обучающая программа поможет Вам создать простой модуль, и должен помочь Вам в создании намного более мощных модулей в будущем. Я опишу здесь только основы, и этот способ поможет Вам в будущем создавать более сложные модули.

В этой обучающей программе мы будем строить модуль hello_world, который должен работать вместе с компонентом с таким же названием, который уже должен быть установлен. В нормальном модуле должно быть 2 файла, для установки и правильного использования. Файл инсталятора hello_world.xml и непосредственно модуль, mod_hello_world.php.

XML
Код файла hello_world.xml должен выглядеть так:

<?xml version="1.0" ?>
<mosinstall type="module">
<name>hello_world</name>
<creationDate>04/14/2004</creationDate>
<author>Doyle Lewis</author>
<copyright>Released under GNU/GPL License</copyright>
<authorEmail>support@mambo-hosting.com</authorEmail>
<authorUrl>www.mambo-hosting.com</authorUrl>
<version>1.0</version>
<description>Module to display "Hello World."</description>
<files>
<filename module="mod_hello_world">mod_hello_world.php</filename>
</files>
</mosinstall>

Теперь давайте выясним, что значат важные линии:

<?xml version="1.0" ?>
Это директива открытия xml. Вам нужно помещать ее в начало любого xml файла.

<mosinstall type="module">
Это сообщение для Limbo что начинается установка модуля.

<copyright>Released under GNU/GPL License</copyright>
Важно сообщить пользователям, каковы условия распространения Вашего модуля. Убедитесь, что лицензия присутствует, дайте людям знать, что Вы позволяете им делать или не делать с вашим модулем.

<description>Module to display "Hello World."</description>
Это сообщение пользователям, для чего предназначен модуль.

<files>
<filename module="mod_hello_world">mod_hello_world.php</filename>
</files>
Это очень важно. Это сообщает Limbo какой файл будет главным в модуле, а также какие еще файлы Вы бы хотели установить.

</mosinstall>
Такой должна быть последняя строка xml файла. Она завершает инсталлятор.

Код модуля
Теперь взгляните на наш модуль mod_hello_world.php. Он вызывает запрос из базы данных, где есть 2 строки `id` and `text`:

<?php
/***************************************************************************
* hello_world Module
* @ Package hello_world
* @ Copyright (C) 2004 Doyle Lewis
* @ All rights reserved
* @ hello_world is Free Software
* @ Released under GNU/GPL License : http://www.gnu.org/copyleft/gpl.html
* @ Version 1.0
**************************************************************************/

defined( '_VALID_ANT' ) or die( 'DirectAccesstothislocationisnotallowed.' );

global $conn;
$row =$conn->GetRow( "SELECT * FROM mos_hello_world");
echo $row['text'];

?>

Рассмотрим подробнее:

defined( '_VALID_ANT' ) or die( 'DirectAccesstothislocationisnotallowed.' );
Это очень важная строка, всегда используйте ее в Ваших модулях для Limbo. Она будет препятствовать людям получать доступ к этому файлу снаружи Limbo.

global $conn;
$conn - это переменная Limbo, которая хранит информацию базы данных. Она используется, как глобальная переменная, так что Вы можете использовать ее всюду в вашем модуле. Она пригодиться Вам, когда Вы будете использовать базу данных.

$row =$conn->GetRow( "SELECT * FROM mos_hello_world");
Это собственно Ваш запрос к базе данных, возвращающий строку в переменную $row .

echo $row['text'];
Это сообщение Limbo показывать колонку 'текст' из Вашей строки. 'текст' в этом случае установлен в "Hello World" так что мы получим желаемый результат.

Вот и весь простой модуль, использующий основной программный интерфейс Limbo. Для получения дополнительной информации о переменной $conn смотрите раздел Программный интерфейс. Вы узнаете много интересного.

<param name=»moduleclass_sfx» type=»text» default=»" label=»CSS-cуффикс класса модуля» description=»Суффикс, который будет использован в описании класса (table.moduletable) таблицы стилей (CSS) модуля. Это позволяет использовать индивидуальный стиль модуля.» /> – здесь указывается, что нужно вывести для редактирования системный параметр определяющий суффикс CSS класса модуля.

<param name=»sometext» type=»textarea» cols=»80″ rows=»5″ default=»" label=»Текст» description=»Обычный текст или текст в формате HTML, который будет выводиться в блоке модуля.» /> – данный параметр служит для вывода в административной части модуля многострочного текстового поля. Запомните имя этого параметра – «sometext». Это имя будет использоваться в дальнейшем.

</params> – закрывает перечень параметров модуля.

</mosinstall> – закрывает инфомационные данные модуля.