Создаем модуль ICQ статуса для Joomla!

joomla модули

Данное руководство ни на что не претендует, просто напишу как сам делаю.

До того как написать вот это я просмотрел несколько подобных руководств и понял что не все они для меня достаточно понятны. Некоторые были слишком просты и ограничивались выводом надписи "Hello World", другие наоборот , а в связи с тем что у меня знаний в области программирования просто никакие пришлось все это долго анализировать просматривать различные готовые модули и пытаться понять как оно работает.

Ну вот и решил написать этот документ который адресуется людям далеким от программирования, но желающим сделать что-то свое.

Сразу скажу что «Hello World» мы делать не будем. А зачем? Практической пользы это не приносит. Мы будем делать что-нибудь полезное и на примере моего «полезного», Вы сделаете свое «полезное».
Погнали.
Вот посидел и придумал, надо сделать ICQ информер. После размещения на сайте он будет показывать есть вы в аське или нет.
Модуль у нас состоит минимум из двух файлов.

mod_myicq.php и mod_myicq.xml

Так я их назвал что бы потом когда установлю этот модуль на сайт можно было отличить его от других установленных модулей. Поэтому имеет смысл давать осмысленные имена (во как закрутил).
Создание установочного файла модуля

Создаем текстовый документ переименовываем его в mod_myicq.xml и вставляем в него код:

<?xml version="1.0" encoding="windows-1251"?>
<mosinstall type="module" version="1.0.0">
<name>ICQ_online?</name>
<author>LightDeath</author>
<creationDate>jule 2008</creationDate>
<copyright>© 2008 Open Source Matters. All rights reserved.</copyright>
<license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license>
<autorEmail>autor(собака)mail.ru</autorEmail>
<authorUrl>http://cms-joomla.info</authorUrl>
<version>1.0.0</version>
<description>Информер статуса ICQ</description>
<files>
<filename module=" mod_myicq "> mod_myicq.php</filename>
</files>
<params>
<param name="moduleclass_sfx"type="text" default=""
label="Суффикс класса модуля" description="Тут можно прописать свой суффикс класса модуля." />
</params>
</mosinstall>

Этот файл можно даже назвать установочным.
Разберем что есть что:
Первая строчка очень важная и должна быть обязательно.


xml version="1.0" эта часть информирует браузер о том, что файл имеет формат XML

encoding="windows-1251 это сообщает браузеру в какой кодировке надо показывать ваш модуль, при необходимости можно исправить на ту кодировку которая является основной для вашего сайта. (помогает когда все выводится крякозябрами).
Самое главное перед этой строчкой не должно быть пробелов и она должна быть самой первой.

<mosinstall type="module" version="1.0.0"> Этот тег говорит Joomla что это вообще такое каким образом и в какую папку установить. А определяет он просто по типу "module".

Ну, а version="1.0.0" это для того чтобы определить на какую версию Joomla этот модуль.

<name>ICQ_online ?</name> Это имя вашего модуля. Оно будет отображаться в списке установленных модулей.

<author>LightDeath</author> Тут мы тешим самолюбие и вписываем свое имя. Ну должны ведь потомки знать кто это наКОДил тут (или нашкодил :)).

<creationDate>jule 2008</creationDate> Здесь указано когда мы это сделали

<copyright>© 2008 Open Source Matters. All rights reserved.</copyright> Здесь наши копирайты. Если вы собираетесь бесплатно раздавать этот модуль, то пусть так и останется. А если вы намерены его продавать , тогда правьте как вам угодно.

<license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license> Эта ссылка на лицензию. Если вы поменяли копирайт то пишите ссылку на свою лицензию.

<authorEmail>autor(@)mail.ru</authorEmail> Ну тут понятно ваша электропочта.Ну надо ведь потом осуществлять поддержку своего творения.

<authorUrl>http://cms-joomla.info</authorUrl> Ссылка на ваш сайт.

<version>1.0.0</version> А это версия Вашего модуля. Вдруг Вы начнете наращивать функционал и исправлять ошибки.

<description>Информер статуса ICQ</description> Ну, а тут описание того что это вообще за чудо такое. Что бы пользователь не забыл что это за модуль такой и для чего он нужен.

<files>
<filename module=" mod_myicq "> mod_myicq.php</filename>
</files>

Между тегами <files></files> мы перечисляем все файлы которые будут входить в ваш модуль, а так как файл *.php в модуле должен быть обязательно, то один файл будет всегда. Выглядеть эта строчка должна именно так, ну только соответственно имя модуля надо будет менять в соответствии с именем модуля. Мы здесь задали атрибут «module» файлу mod_nmyicq.php и он принял значение имени модуля без расширения. Короче мы сообщили Joomla каким файлом запускать ваш модуль. Потом попозже мы попробуем добавить другие файлы в ваш модуль (например картинки), а пока этого нам достаточно.

<params>
<param name="moduleclass_sfx" type="text" default="" label="Суффикс класса модуля" description="Тут можно прописать свой суффикс класса модуля." />
</params>

Вот мы дошли до интересных тегов <params></params>. Между этих тегов мы будем добавлять параметры которые будут использоваться для настройки вашего модуля. Вернемся к ним попозже когда будем их добавлять. А сейчас посмотрите тот параметр который у нас указан. Он в принципе не обязателен, но ставить его как мне кажется признак хорошего тона. Вдруг человек который воспользуется вашим модулем захочет применить свой стиль CSS к вашему модулю ну и пожалуйста, мы все для него подготовили.

Ну и вроде все закрываем тег </mosinstall> который сообщает что файлик кончился.
Сохраняем то что у нас получилось.


Источник: http://joomlaforum.org

Добавить комментарий:
Имя:
E-mail:
2021 © Обсуждение Joomla и других CMS-систем управления сайтами  Правила | О проекте | Обратная связь